com.guiseframework.component
Class ImageBooleanSelectActionControl

java.lang.Object
  com.globalmentor.beans.BoundPropertyObject
      com.guiseframework.event.GuiseBoundPropertyObject
          com.guiseframework.model.ui.AbstractPresentationModel
              com.guiseframework.component.AbstractComponent
                  com.guiseframework.component.AbstractControl
                      com.guiseframework.component.AbstractActionControl
                          com.guiseframework.component.AbstractActionValueControl<java.lang.Boolean>
                              com.guiseframework.component.AbstractBooleanSelectActionControl
                                  com.guiseframework.component.ImageBooleanSelectActionControl

All Implemented Interfaces:

com.globalmentor.beans.PropertyBindable, com.globalmentor.beans.PropertyConstrainable, ActionControl, ActionValueControl<java.lang.Boolean>, Component, Control, ImageComponent, InputFocusableComponent, LabelDisplayableComponent, SelectActionControl, ValueControl<java.lang.Boolean>, ValuedComponent<java.lang.Boolean>, ActionListenable, ActionModel, Displayable, Enableable, ImageModel, InfoModel, LabelModel, Model, Selectable, PresentationModel, Valued<java.lang.Boolean>, ValueModel<java.lang.Boolean>, DepictedObject

public class ImageBooleanSelectActionControl
extends AbstractBooleanSelectActionControl
implements ImageComponent

Image control that can be selected and generates actions, storing a Boolean value in its model representing the selected state.

Author:

Garret Wilson

Nested Class Summary

Nested classes/interfaces inherited from class com.guiseframework.component.AbstractComponent

AbstractComponent.AbstractFlyoverFrameStrategy<S extends Component>, AbstractComponent.AbstractFlyoverStrategy<S extends Component>, AbstractComponent.DefaultFlyoverStrategy<S extends Component>

Nested classes/interfaces inherited from interface com.guiseframework.component.Component

Component.FlyoverStrategy<S extends Component>

Nested classes/interfaces inherited from interface com.guiseframework.component.Control

Control.Status

Field Summary

static java.lang.String	ROLLOVER_IMAGE_URI_PROPERTY The rollover image URI bound property.
static java.lang.String	SELECTED_IMAGE_URI_PROPERTY The selected image URI bound property.

Fields inherited from class com.globalmentor.beans.BoundPropertyObject

NO_PROPERTY_CHANGE_LISTENERS, NO_VETOABLE_CHANGE_LISTENERS

Fields inherited from interface com.guiseframework.component.Component

BOOKMARK_ENABLED_PROPERTY, CONSTRAINTS_PROPERTY, DRAG_ENABLED_PROPERTY, DROP_ENABLED_PROPERTY, FLYOVER_ENABLED_PROPERTY, FLYOVER_STRATEGY_PROPERTY, INPUT_STRATEGY_PROPERTY, NAME_PROPERTY, NOTIFICATION_PROPERTY, ORIENTATION_PROPERTY, THEME_APPLIED_PROPERTY, VALID_PROPERTY

Fields inherited from interface com.guiseframework.model.ui.PresentationModel

BACKGROUND_COLOR_PROPERTY, BORDER_LINE_FAR_COLOR_PROPERTY, BORDER_LINE_FAR_EXTENT_PROPERTY, BORDER_LINE_FAR_STYLE_PROPERTY, BORDER_LINE_NEAR_COLOR_PROPERTY, BORDER_LINE_NEAR_EXTENT_PROPERTY, BORDER_LINE_NEAR_STYLE_PROPERTY, BORDER_PAGE_FAR_COLOR_PROPERTY, BORDER_PAGE_FAR_EXTENT_PROPERTY, BORDER_PAGE_FAR_STYLE_PROPERTY, BORDER_PAGE_NEAR_COLOR_PROPERTY, BORDER_PAGE_NEAR_EXTENT_PROPERTY, BORDER_PAGE_NEAR_STYLE_PROPERTY, CORNER_LINE_FAR_PAGE_FAR_ARC_SIZE_PROPERTY, CORNER_LINE_FAR_PAGE_NEAR_ARC_SIZE_PROPERTY, CORNER_LINE_NEAR_PAGE_FAR_ARC_SIZE_PROPERTY, CORNER_LINE_NEAR_PAGE_NEAR_ARC_SIZE_PROPERTY, CURSOR_PROPERTY, FONT_FAMILIES_PROPERTY, FONT_SIZE_PROPERTY, FONT_STYLE_PROPERTY, FONT_WEIGHT_BOLD, FONT_WEIGHT_NORMAL, FONT_WEIGHT_PROPERTY, LABEL_FONT_FAMILIES_PROPERTY, LABEL_FONT_SIZE_PROPERTY, LABEL_FONT_STYLE_PROPERTY, LABEL_FONT_WEIGHT_PROPERTY, LABEL_TEXT_COLOR_PROPERTY, LINE_EXTENT_PROPERTY, MARGIN_LINE_FAR_EXTENT_PROPERTY, MARGIN_LINE_NEAR_EXTENT_PROPERTY, MARGIN_PAGE_FAR_EXTENT_PROPERTY, MARGIN_PAGE_NEAR_EXTENT_PROPERTY, OPACITY_PROPERTY, PADDING_LINE_FAR_EXTENT_PROPERTY, PADDING_LINE_NEAR_EXTENT_PROPERTY, PADDING_PAGE_FAR_EXTENT_PROPERTY, PADDING_PAGE_NEAR_EXTENT_PROPERTY, PAGE_EXTENT_PROPERTY, ROUNDED_CORNER_ARC_SIZE, STYLE_ID_PROPERTY, TEXT_COLOR_PROPERTY, TOOLTIP_ENABLED_PROPERTY, VISIBLE_PROPERTY

Fields inherited from interface com.guiseframework.model.Displayable

DISPLAYED_PROPERTY

Fields inherited from interface com.guiseframework.model.InfoModel

DESCRIPTION_CONTENT_TYPE_PROPERTY, DESCRIPTION_PROPERTY, INFO_CONTENT_TYPE_PROPERTY, INFO_PROPERTY

Fields inherited from interface com.guiseframework.model.LabelModel

GLYPH_URI_PROPERTY, LABEL_CONTENT_TYPE_PROPERTY, LABEL_PROPERTY

Fields inherited from interface com.guiseframework.model.Model

PLAIN_TEXT_CONTENT_TYPE, XHTML_CONTENT_TYPE, XHTML_FRAGMENT_CONTENT_TYPE

Fields inherited from interface com.guiseframework.model.ImageModel

IMAGE_URI_PROPERTY

Fields inherited from interface com.guiseframework.component.SelectActionControl

AUTO_SELECT_PROPERTY, SELECTED_GLYPH_URI_PROPERTY, TOGGLE_PROPERTY, UNSELECTED_GLYPH_URI_PROPERTY

Fields inherited from interface com.guiseframework.component.ActionControl

ROLLOVER_PROPERTY

Fields inherited from interface com.guiseframework.component.Control

STATUS_PROPERTY

Fields inherited from interface com.guiseframework.model.Enableable

ENABLED_PROPERTY

Fields inherited from interface com.guiseframework.model.Selectable

SELECTED_PROPERTY

Fields inherited from interface com.guiseframework.component.ActionValueControl

VALUE_GLYPH_URI_PROPERTY

Fields inherited from interface com.guiseframework.component.ValueControl

CONVERTER_PROPERTY

Fields inherited from interface com.guiseframework.model.ValueModel

VALIDATOR_PROPERTY, VALUE_PROPERTY

Fields inherited from interface com.guiseframework.component.LabelDisplayableComponent

ICON_DISPLAYED_PROPERTY, LABEL_DISPLAYED_PROPERTY

Constructor Summary

ImageBooleanSelectActionControl()
Default constructor.

ImageBooleanSelectActionControl(InfoModel infoModel, ImageModel imageModel, ActionModel actionModel, ValueModel<java.lang.Boolean> valueModel, Enableable enableable)
Info model, image model, action model, value model, and enableable object constructor.

ImageBooleanSelectActionControl(ValuePrototype<java.lang.Boolean> valuePrototype)
Prototype constructor.

Method Summary

protected ImageModel	getImageModel()
java.net.URI	getImageURI()
java.net.URI	getRolloverImageURI()
java.net.URI	getSelectedImageURI()
void	setImageURI(java.net.URI newImageURI) Sets the URI of the image.
void	setRolloverImageURI(java.net.URI newRolloverImageURI) Sets the URI of the rollover image.
void	setSelectedImageURI(java.net.URI newSelectedImageURI) Sets the URI of the selected image.

Methods inherited from class com.guiseframework.component.AbstractBooleanSelectActionControl

getSelectedGlyphURI, getUnselectedGlyphURI, isAutoSelect, isSelected, isToggle, setAutoSelect, setSelected, setSelectedGlyphURI, setToggle, setUnselectedGlyphURI

Methods inherited from class com.guiseframework.component.AbstractActionValueControl

clearValue, determineValid, firePropertyChange, getDefaultValue, getValidator, getValue, getValueClass, getValueGlyphURI, getValueModel, isValidValue, reset, resetValue, setValidator, setValue, setValueGlyphURI, validate, validateValue

Methods inherited from class com.guiseframework.component.AbstractActionControl

addActionListener, fireActionPerformed, fireActionPerformed, getActionListeners, getActionModel, isIconDisplayed, isLabelDisplayed, isRollover, performAction, performAction, removeActionListener, setIconDisplayed, setLabelDisplayed, setRollover

Methods inherited from class com.guiseframework.component.AbstractControl

determineStatus, getEnableable, getStatus, isEnabled, setEnabled, setNotification, setStatus, updateStatus, updateValid

Methods inherited from class com.guiseframework.component.AbstractComponent

addCommandListener, addExportStrategy, addImportStrategy, addKeyListener, addMouseListener, addNotificationListener, addPreferenceProperty, applyTheme, applyTheme, depict, dispatchInputEvent, equals, exportTransfer, fireInputEvent, fireNotified, fireNotified, getAncestor, getCommandListeners, getComponentByID, getComponentByName, getComponentOrientation, getConstraints, getDepictID, getDepictor, getDescription, getDescriptionContentType, getDirtyComponents, getDirtyComponents, getEventListenerManager, getFlyoverStrategy, getGlyphURI, getInfo, getInfoContentType, getInfoModel, getInputStrategy, getKeyListeners, getLabel, getLabelContentType, getMouseListeners, getName, getNotification, getNotifications, getNotifications, getOrientation, getParent, getPreferenceProperties, getRootComponent, getTheme, hasAncestor, hasCommandListeners, hashCode, hasKeyListeners, hasMouseListeners, importTransfer, initialize, isDragEnabled, isDropEnabled, isFlyoverEnabled, isPreferenceProperty, isThemeApplied, isValid, loadPreferences, notify, processEvent, removeCommandListener, removeExportStrategy, removeImportStrategy, removeKeyListener, removeMouseListener, removeNotificationListener, removePreferenceProperty, resetTheme, savePreferences, setConstraints, setDepicted, setDescription, setDescriptionContentType, setDragEnabled, setDropEnabled, setFlyoverEnabled, setFlyoverStrategy, setGlyphURI, setInfo, setInfoContentType, setInputStrategy, setLabel, setLabelContentType, setName, setOrientation, setParent, setThemeApplied, setValid, toString, update, updateTheme

Methods inherited from class com.guiseframework.model.ui.AbstractPresentationModel

BorderLineFarColor, BorderLineFarExtent, BorderLineFarStyle, BorderLineNearColor, BorderLineNearExtent, BorderLineNearStyle, BorderPageFarColor, BorderPageFarExtent, BorderPageFarStyle, BorderPageNearColor, BorderPageNearExtent, BorderPageNearStyle, getBackgroundColor, getBorderColor, getBorderExtent, getBorderStyle, getCornerArcSize, getCornerLineFarPageFarArcSize, getCornerLineFarPageNearArcSize, getCornerLineNearPageFarArcSize, getCornerLineNearPageNearArcSize, getCursor, getExtent, getFontFamilies, getFontSize, getFontStyle, getFontWeight, getLabelFontFamilies, getLabelFontSize, getLabelFontStyle, getLabelFontWeight, getLabelTextColor, getLineExtent, getMarginExtent, getMarginLineFarExtent, getMarginLineNearExtent, getMarginPageFarExtent, getMarginPageNearExtent, getOpacity, getPaddingExtent, getPaddingLineFarExtent, getPaddingLineNearExtent, getPaddingPageFarExtent, getPaddingPageNearExtent, getPageExtent, getStyleID, getTextColor, isDisplayed, isTooltipEnabled, isVisible, setBackgroundColor, setBorderColor, setBorderColor, setBorderExtent, setBorderExtent, setBorderLineFarColor, setBorderLineFarExtent, setBorderLineFarStyle, setBorderLineNearColor, setBorderLineNearExtent, setBorderLineNearStyle, setBorderPageFarColor, setBorderPageFarExtent, setBorderPageFarStyle, setBorderPageNearColor, setBorderPageNearExtent, setBorderPageNearStyle, setBorderStyle, setBorderStyle, setCornerArcSize, setCornerArcSize, setCornerLineFarPageFarArcSize, setCornerLineFarPageNearArcSize, setCornerLineNearPageFarArcSize, setCornerLineNearPageNearArcSize, setCursor, setDisplayed, setExtent, setFontFamilies, setFontSize, setFontStyle, setFontWeight, setLabelFontFamilies, setLabelFontSize, setLabelFontStyle, setLabelFontWeight, setLabelTextColor, setLineExtent, setMarginExtent, setMarginExtent, setMarginLineFarExtent, setMarginLineNearExtent, setMarginPageFarExtent, setMarginPageNearExtent, setOpacity, setPaddingExtent, setPaddingExtent, setPaddingLineFarExtent, setPaddingLineNearExtent, setPaddingPageFarExtent, setPaddingPageNearExtent, setPageExtent, setStyleID, setTextColor, setTooltipEnabled, setVisible

Methods inherited from class com.guiseframework.event.GuiseBoundPropertyObject

getSession

Methods inherited from class com.globalmentor.beans.BoundPropertyObject

addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, addVetoableChangeListener, createPostponedPropertyChangeEvent, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, getForwardPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, getPropertyChangeSupport, getRepeatPropertyChangeListener, getRepeatVetoableChangeListener, getVetoableChangeListeners, getVetoableChangeListeners, getVetoableChangeSupport, hasPropertyChangeListeners, hasVetoableChangeListeners, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, removeVetoableChangeListener

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.guiseframework.component.Component

addCommandListener, addExportStrategy, addImportStrategy, addKeyListener, addMouseListener, addNotificationListener, addPreferenceProperty, applyTheme, applyTheme, dispatchInputEvent, exportTransfer, fireInputEvent, getAncestor, getComponentOrientation, getConstraints, getDepictor, getFlyoverStrategy, getInputStrategy, getName, getNotification, getOrientation, getParent, getPreferenceProperties, getTheme, hasCommandListeners, hasKeyListeners, hasMouseListeners, importTransfer, initialize, isDragEnabled, isDropEnabled, isFlyoverEnabled, isPreferenceProperty, isThemeApplied, isValid, loadPreferences, notify, removeCommandListener, removeExportStrategy, removeImportStrategy, removeKeyListener, removeMouseListener, removeNotificationListener, removePreferenceProperty, resetTheme, savePreferences, setConstraints, setDragEnabled, setDropEnabled, setFlyoverEnabled, setFlyoverStrategy, setInputStrategy, setName, setNotification, setOrientation, setParent, setThemeApplied, updateTheme, validate

Methods inherited from interface com.guiseframework.platform.DepictedObject

depict, getDepictID, getSession, processEvent

Methods inherited from interface com.guiseframework.model.ui.PresentationModel

BorderLineFarColor, BorderLineFarExtent, BorderLineFarStyle, BorderLineNearColor, BorderLineNearExtent, BorderLineNearStyle, BorderPageFarColor, BorderPageFarExtent, BorderPageFarStyle, BorderPageNearColor, BorderPageNearExtent, BorderPageNearStyle, getBackgroundColor, getBorderColor, getBorderExtent, getBorderStyle, getCornerArcSize, getCornerLineFarPageFarArcSize, getCornerLineFarPageNearArcSize, getCornerLineNearPageFarArcSize, getCornerLineNearPageNearArcSize, getCursor, getExtent, getFontFamilies, getFontSize, getFontStyle, getFontWeight, getLabelFontFamilies, getLabelFontSize, getLabelFontStyle, getLabelFontWeight, getLabelTextColor, getLineExtent, getMarginExtent, getMarginLineFarExtent, getMarginLineNearExtent, getMarginPageFarExtent, getMarginPageNearExtent, getOpacity, getPaddingExtent, getPaddingLineFarExtent, getPaddingLineNearExtent, getPaddingPageFarExtent, getPaddingPageNearExtent, getPageExtent, getSession, getStyleID, getTextColor, isDisplayed, isTooltipEnabled, isVisible, setBackgroundColor, setBorderColor, setBorderColor, setBorderExtent, setBorderExtent, setBorderLineFarColor, setBorderLineFarExtent, setBorderLineFarStyle, setBorderLineNearColor, setBorderLineNearExtent, setBorderLineNearStyle, setBorderPageFarColor, setBorderPageFarExtent, setBorderPageFarStyle, setBorderPageNearColor, setBorderPageNearExtent, setBorderPageNearStyle, setBorderStyle, setBorderStyle, setCornerArcSize, setCornerArcSize, setCornerLineFarPageFarArcSize, setCornerLineFarPageNearArcSize, setCornerLineNearPageFarArcSize, setCornerLineNearPageNearArcSize, setCursor, setDisplayed, setExtent, setFontFamilies, setFontSize, setFontStyle, setFontWeight, setLabelFontFamilies, setLabelFontSize, setLabelFontStyle, setLabelFontWeight, setLabelTextColor, setLineExtent, setMarginExtent, setMarginExtent, setMarginLineFarExtent, setMarginLineNearExtent, setMarginPageFarExtent, setMarginPageNearExtent, setOpacity, setPaddingExtent, setPaddingExtent, setPaddingLineFarExtent, setPaddingLineNearExtent, setPaddingPageFarExtent, setPaddingPageNearExtent, setPageExtent, setStyleID, setTextColor, setTooltipEnabled, setVisible

Methods inherited from interface com.guiseframework.model.InfoModel

getDescription, getDescriptionContentType, getInfo, getInfoContentType, setDescription, setDescriptionContentType, setInfo, setInfoContentType

Methods inherited from interface com.guiseframework.model.LabelModel

getGlyphURI, getLabel, getLabelContentType, setGlyphURI, setLabel, setLabelContentType

Methods inherited from interface com.globalmentor.beans.PropertyBindable

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, hasPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from interface com.globalmentor.beans.PropertyConstrainable

addVetoableChangeListener, addVetoableChangeListener, getVetoableChangeListeners, getVetoableChangeListeners, hasVetoableChangeListeners, removeVetoableChangeListener, removeVetoableChangeListener

Methods inherited from interface com.guiseframework.component.ActionControl

isRollover, setRollover

Methods inherited from interface com.guiseframework.component.Control

getStatus, reset

Methods inherited from interface com.guiseframework.model.Enableable

isEnabled, setEnabled

Methods inherited from interface com.guiseframework.model.ActionModel

getActionListeners, performAction, performAction

Methods inherited from interface com.guiseframework.event.ActionListenable

addActionListener, removeActionListener

Field Detail

ROLLOVER_IMAGE_URI_PROPERTY

public static final java.lang.String ROLLOVER_IMAGE_URI_PROPERTY

The rollover image URI bound property.

SELECTED_IMAGE_URI_PROPERTY

public static final java.lang.String SELECTED_IMAGE_URI_PROPERTY

The selected image URI bound property.

Constructor Detail

ImageBooleanSelectActionControl

public ImageBooleanSelectActionControl()

Default constructor.

ImageBooleanSelectActionControl

public ImageBooleanSelectActionControl(InfoModel infoModel,
                                       ImageModel imageModel,
                                       ActionModel actionModel,
                                       ValueModel<java.lang.Boolean> valueModel,
                                       Enableable enableable)

Info model, image model, action model, value model, and enableable object constructor.

Parameters:

infoModel - The component info model.

imageModel - The component image model.

actionModel - The component action model.

valueModel - The component value model.

enableable - The enableable object in which to store enabled status.

Throws:

java.lang.NullPointerException - if the given info model, image model, action model, and/or enableable object is null.

ImageBooleanSelectActionControl

public ImageBooleanSelectActionControl(ValuePrototype<java.lang.Boolean> valuePrototype)

Prototype constructor.

Parameters:

valuePrototype - The prototype on which this component should be based.

Method Detail

getImageModel

protected ImageModel getImageModel()

Returns:

The image model used by this component.

getImageURI

public java.net.URI getImageURI()

Specified by:

getImageURI in interface ImageModel

Returns:

The image URI, which may be a resource URI, or null if there is no image URI.

setImageURI

public void setImageURI(java.net.URI newImageURI)

Sets the URI of the image. This is a bound property of type URI.

Specified by:

setImageURI in interface ImageModel

Parameters:

newImageURI - The new URI of the image, which may be a resource URI.

See Also:

ImageModel.IMAGE_URI_PROPERTY

getRolloverImageURI

public java.net.URI getRolloverImageURI()

Returns:

The rollover image URI, which may be a resource URI, or null if there is no rollover image URI.

setRolloverImageURI

public void setRolloverImageURI(java.net.URI newRolloverImageURI)

Sets the URI of the rollover image. This is a bound property of type URI.

Parameters:

newRolloverImageURI - The new URI of the rollover image, which may be a resource URI.

See Also:

ROLLOVER_IMAGE_URI_PROPERTY

getSelectedImageURI

public java.net.URI getSelectedImageURI()

Returns:

The selected image URI, which may be a resource URI, or null if there is no selected image URI.

setSelectedImageURI

public void setSelectedImageURI(java.net.URI newSelectedImageURI)

Sets the URI of the selected image. This is a bound property of type URI.

Parameters:

newSelectedImageURI - The new URI of the selected image, which may be a resource URI.

See Also:

SELECTED_IMAGE_URI_PROPERTY