com.guiseframework.component
Interface SelectActionControl

All Superinterfaces:

ActionControl, ActionListenable, ActionModel, Component, Control, DepictedObject, Displayable, Enableable, InfoModel, InputFocusableComponent, LabelModel, Model, PresentationModel, com.globalmentor.beans.PropertyBindable, com.globalmentor.beans.PropertyConstrainable, Selectable

All Known Subinterfaces:

SelectButtonControl, SelectLinkControl

All Known Implementing Classes:

AbstractBooleanSelectActionControl, AbstractSelectActionControl, AbstractSelectActionValueControl, BooleanSelectButton, BooleanSelectLink, BooleanSelectToolButton, ImageBooleanSelectActionControl, SelectButton, SelectLink, TaskStateSelectLink, ValueSelectButton, ValueSelectLink

public interface SelectActionControl
extends ActionControl, Selectable

An action control that keeps track of its selected state. If the control is set to be toggled, when the action is initiated the selected state alternates between true and false. Otherwise, an action sets the selected state to true. The control defaults to auto-select mode. If this mode is turned off, no selection or toggling occurs automatically when the action occurs.

Author:

Garret Wilson

Nested Class Summary

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

Control.Status

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

Component.FlyoverStrategy<S extends Component>

Field Summary

static java.lang.String	AUTO_SELECT_PROPERTY The auto-select bound property.
static java.lang.String	SELECTED_GLYPH_URI_PROPERTY The selected icon bound property.
static java.lang.String	TOGGLE_PROPERTY The toggle bound property.
static java.lang.String	UNSELECTED_GLYPH_URI_PROPERTY The unselected icon bound 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.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.Enableable

ENABLED_PROPERTY

Fields inherited from interface com.guiseframework.model.Selectable

SELECTED_PROPERTY

Method Summary

java.net.URI	getSelectedGlyphURI()
java.net.URI	getUnselectedGlyphURI()
boolean	isAutoSelect()
boolean	isToggle()
void	setAutoSelect(boolean newAutoSelect) Sets whether this control automatically sets or toggles the selection state when the action occurs.
void	setSelectedGlyphURI(java.net.URI newSelectedIcon) Sets the URI of the selected icon.
void	setToggle(boolean newToggle) Sets whether this control acts as a toggle, switching its value between true and false, or whether the action always sets the value to true.
void	setUnselectedGlyphURI(java.net.URI newUnselectedIcon) Sets the URI of the unselected icon.

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.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.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

Methods inherited from interface com.guiseframework.model.Selectable

isSelected, setSelected

Field Detail

AUTO_SELECT_PROPERTY

static final java.lang.String AUTO_SELECT_PROPERTY

The auto-select bound property.

SELECTED_GLYPH_URI_PROPERTY

static final java.lang.String SELECTED_GLYPH_URI_PROPERTY

The selected icon bound property.

TOGGLE_PROPERTY

static final java.lang.String TOGGLE_PROPERTY

The toggle bound property.

UNSELECTED_GLYPH_URI_PROPERTY

static final java.lang.String UNSELECTED_GLYPH_URI_PROPERTY

The unselected icon bound property.

Method Detail

isAutoSelect

boolean isAutoSelect()

Returns:

Whether this control automatically sets or toggles the selection state when the action occurs.

setAutoSelect

void setAutoSelect(boolean newAutoSelect)

Sets whether this control automatically sets or toggles the selection state when the action occurs. This is a bound property of type Boolean.

Parameters:

newAutoSelect - true if the control should automatically set or toggle the selection state when an action occurs.

See Also:

AUTO_SELECT_PROPERTY

getSelectedGlyphURI

java.net.URI getSelectedGlyphURI()

Returns:

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

setSelectedGlyphURI

void setSelectedGlyphURI(java.net.URI newSelectedIcon)

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

Parameters:

newSelectedIcon - The new URI of the selected icon, which may be a resource URI.

See Also:

SELECTED_GLYPH_URI_PROPERTY

isToggle

boolean isToggle()

Returns:

Whether this control acts as a toggle, switching its value between true and false, or whether the action always sets the value to true.

setToggle

void setToggle(boolean newToggle)

Sets whether this control acts as a toggle, switching its value between true and false, or whether the action always sets the value to true. This is a bound property of type Boolean.

Parameters:

newToggle - true if the component should act as a toggle, else false if the action should unconditionally set the value to true.

See Also:

TOGGLE_PROPERTY

getUnselectedGlyphURI

java.net.URI getUnselectedGlyphURI()

Returns:

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

setUnselectedGlyphURI

void setUnselectedGlyphURI(java.net.URI newUnselectedIcon)

Sets the URI of the unselected icon. This is a bound property of type URI.

Parameters:

newUnselectedIcon - The new URI of the unselected icon, which may be a resource URI.

See Also:

UNSELECTED_GLYPH_URI_PROPERTY