Package io.guise.framework.coupler
Class ActionCardCoupler
java.lang.Object
com.globalmentor.beans.BoundPropertyObject
io.guise.framework.event.GuiseBoundPropertyObject
io.guise.framework.coupler.AbstractCardCoupler
io.guise.framework.coupler.ActionCardCoupler
- All Implemented Interfaces:
com.globalmentor.beans.PropertyBindable
,com.globalmentor.beans.PropertyConstrainable
Associates an action control with a card in a card control. When the action is initiated, the first displayed and enabled specified card within the card
control will be selected. When any of the the associated cards are selected, if the action implements
Selectable
the action will be selected. If the
card's constraints implement Displayable
, the action will be displayed based upon the card constraints' displayed status. If the card's constraints
implement Enableable
, the action will be enabled based upon the card constraints' enabled status. If a card's constraints implement
TaskCardConstraints
and the action implements ActionValueControl
and represents a TaskState
value, the action's contained value will
reflect any changes in the card constraints task state. If the action implements SelectActionControl
its auto-select status will be turned off when
installed. This coupler is only functional when the given card is contained within a CardControl
.- Author:
- Garret Wilson
-
Field Summary
Fields inherited from class io.guise.framework.coupler.AbstractCardCoupler
CARD_PROPERTY, CARDS_PROPERTY
Fields inherited from class com.globalmentor.beans.BoundPropertyObject
NO_PROPERTY_CHANGE_LISTENERS, NO_VETOABLE_CHANGE_LISTENERS
-
Constructor Summary
ConstructorDescriptionDefault constructor.ActionCardCoupler
(ActionControl actionControl, Component... cards) Action and cards constructor. -
Method Summary
Modifier and TypeMethodDescriptionvoid
setAction
(ActionControl newAction) Sets the connected action.protected void
updateDisplayed
(boolean displayed) Updates the current displayed status.protected void
updateEnabled
(boolean enabled) Updates the current enabled status.protected void
updateSelected
(boolean selected) Updates the current selected status.protected void
updateTaskState
(com.globalmentor.model.TaskState taskState) Updates the current task state.Methods inherited from class io.guise.framework.coupler.AbstractCardCoupler
getCard, getCardControl, getCards, installCardConstraints, isCardSelectable, selectCard, selectCard, setCard, setCards, uninstallCardConstraints, updateDisplayed, updateEnabled, updateSelected, updateTaskState
Methods inherited from class io.guise.framework.event.GuiseBoundPropertyObject
getSession
Methods inherited from class com.globalmentor.beans.BoundPropertyObject
addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, addVetoableChangeListener, createPostponedPropertyChangeEvent, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, getForwardPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, getPropertyChangeSupport, getRepeatPropertyChangeListener, getRepeatVetoableChangeListener, getVetoableChangeListeners, getVetoableChangeListeners, getVetoableChangeSupport, hasPropertyChangeListeners, hasVetoableChangeListeners, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, removeVetoableChangeListener
-
Field Details
-
ACTION_PROPERTY
The bound property of the action.
-
-
Constructor Details
-
ActionCardCoupler
public ActionCardCoupler()Default constructor. -
ActionCardCoupler
Action and cards constructor.- Parameters:
actionControl
- The new action to connect to the card, ornull
if the action should not be coupled with a card.cards
- The new cards to connect, if any.
-
-
Method Details
-
getAction
- Returns:
- The action to connect to the card, or
null
if the action is not coupled with a card.
-
setAction
Sets the connected action. This is a bound property.- Parameters:
newAction
- The new action to connect to the card, ornull
if the action should not be coupled with a card.- See Also:
-
updateDisplayed
protected void updateDisplayed(boolean displayed) Updates the current displayed status. This implementation does nothing.This implementation updates the action's displayed status. If no action is connected, no action occurs.
- Overrides:
updateDisplayed
in classAbstractCardCoupler
- Parameters:
displayed
- The new displayed status.
-
updateEnabled
protected void updateEnabled(boolean enabled) Updates the current enabled status. This implementation does nothing.This implementation updates the action's enabled status. If no action is connected, no action occurs.
- Overrides:
updateEnabled
in classAbstractCardCoupler
- Parameters:
enabled
- The new enabled status.
-
updateTaskState
protected void updateTaskState(com.globalmentor.model.TaskState taskState) Description copied from class:AbstractCardCoupler
Updates the current task state. This implementation does nothing.- Overrides:
updateTaskState
in classAbstractCardCoupler
- Parameters:
taskState
- The new task state, ornull
if there is no task state.
-
updateSelected
protected void updateSelected(boolean selected) Description copied from class:AbstractCardCoupler
Updates the current selected status. This implementation does nothing.- Overrides:
updateSelected
in classAbstractCardCoupler
- Parameters:
selected
- The new selected status.
-