com.sun.rave.designtime
Class BasicCheckedDisplayAction


java.lang.Object

  extended bycom.sun.rave.designtime.BasicDisplayAction

      extended bycom.sun.rave.designtime.BasicCheckedDisplayAction

All Implemented Interfaces:
CheckedDisplayAction, DisplayAction, DisplayItem

public class BasicCheckedDisplayAction
extends BasicDisplayAction
implements CheckedDisplayAction

A basic implementation of CheckedDisplayAction to use for convenience.

Version:
1.0
Author:
Joe Nuxoll
See Also:
CheckedDisplayAction

Field Summary
protected  boolean checked
           
 
Fields inherited from class com.sun.rave.designtime.BasicDisplayAction
description, displayName, EMPTY_ARRAY, enabled, helpKey, largeIcon, smallIcon
 
Constructor Summary
BasicCheckedDisplayAction()
           
BasicCheckedDisplayAction(java.lang.String displayName)
           
BasicCheckedDisplayAction(java.lang.String displayName, java.lang.String description)
           
BasicCheckedDisplayAction(java.lang.String displayName, java.lang.String description, java.lang.String helpKey)
           
BasicCheckedDisplayAction(java.lang.String displayName, java.lang.String description, java.lang.String helpKey, java.awt.Image smallIcon)
           
BasicCheckedDisplayAction(java.lang.String displayName, java.lang.String description, java.lang.String helpKey, java.awt.Image smallIcon, java.awt.Image largeIcon)
           
 
Method Summary
 Result invoke()
          This method is called when a DisplayAction is selected from a context menu or 'clicked' when it is displayed as a button.
 boolean isChecked()
          Returns the boolean checked state of this display item.
 void setChecked(boolean checked)
           
 
Methods inherited from class com.sun.rave.designtime.BasicDisplayAction
getDescription, getDisplayName, getHelpKey, getLargeIcon, getSmallIcon, isEnabled, setDescription, setDisplayName, setEnabled, setHelpKey, setLargeIcon, setSmallIcon
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.sun.rave.designtime.DisplayAction
isEnabled
 
Methods inherited from interface com.sun.rave.designtime.DisplayItem
getDescription, getDisplayName, getHelpKey, getLargeIcon, getSmallIcon
 

Field Detail

checked


protected boolean checked
Constructor Detail

BasicCheckedDisplayAction


public BasicCheckedDisplayAction()

BasicCheckedDisplayAction


public BasicCheckedDisplayAction(java.lang.String displayName)

BasicCheckedDisplayAction


public BasicCheckedDisplayAction(java.lang.String displayName,
                                 java.lang.String description)

BasicCheckedDisplayAction


public BasicCheckedDisplayAction(java.lang.String displayName,
                                 java.lang.String description,
                                 java.lang.String helpKey)

BasicCheckedDisplayAction


public BasicCheckedDisplayAction(java.lang.String displayName,
                                 java.lang.String description,
                                 java.lang.String helpKey,
                                 java.awt.Image smallIcon)

BasicCheckedDisplayAction


public BasicCheckedDisplayAction(java.lang.String displayName,
                                 java.lang.String description,
                                 java.lang.String helpKey,
                                 java.awt.Image smallIcon,
                                 java.awt.Image largeIcon)
Method Detail

invoke


public Result invoke()
Description copied from interface: DisplayAction
This method is called when a DisplayAction is selected from a context menu or 'clicked' when it is displayed as a button.

Specified by:
invoke in interface DisplayAction
Overrides:
invoke in class BasicDisplayAction

isChecked


public boolean isChecked()
Description copied from interface: CheckedDisplayAction
Returns the boolean checked state of this display item.

Specified by:
isChecked in interface CheckedDisplayAction
Returns:
true if this display action is checked, and false if not

setChecked


public void setChecked(boolean checked)