Module org.jhotdraw8.application

Package org.jhotdraw8.application.action

Class AbstractAction

java.lang.Object

org.jhotdraw8.application.AbstractDisableable

org.jhotdraw8.application.action.AbstractAction

All Implemented Interfaces:

EventListener, javafx.event.EventHandler<javafx.event.ActionEvent>, Action, PropertyBean, Disableable

Direct Known Subclasses:

AbstractApplicationAction, ScreenMenuBarProxyAction

public abstract class AbstractAction
extends AbstractDisableable
implements Action

AbstractAction.

Author:

Werner Randelshofer

Property Summary

Properties

Type	Property	Description
@NonNull javafx.beans.property.BooleanProperty	selected	The Boolean that corresponds to the selected state.

Properties inherited from class org.jhotdraw8.application.AbstractDisableable

disabled

Properties inherited from interface org.jhotdraw8.fxbase.control.Disableable

disabled

Field Summary

Fields

Modifier and Type	Field	Description
protected final javafx.collections.ObservableMap<org.jhotdraw8.fxcollection.typesafekey.Key<?>,Object>	properties	Holds the properties.

Fields inherited from class org.jhotdraw8.application.AbstractDisableable

disabled, disablers

Fields inherited from interface org.jhotdraw8.application.action.Action

ACCELERATOR_KEY, ID_KEY, LABEL, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, SELECTED_PROPERTY, SHORT_DESCRIPTION, SMALL_ICON

Fields inherited from interface org.jhotdraw8.fxbase.control.Disableable

DISABLED_PROPERTY

Constructor Summary

Constructors

Constructor	Description
AbstractAction()	Creates a new instance.
AbstractAction(String id)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
final @NonNull javafx.collections.ObservableMap<org.jhotdraw8.fxcollection.typesafekey.Key<?>,Object>	getProperties()
final void	handle(@NonNull javafx.event.ActionEvent event)	Invokes onActionPerformed(javafx.event.ActionEvent) if the action is not disabled and the event is not consumed.
protected abstract void	onActionPerformed(@NonNull javafx.event.ActionEvent event)	This method is invoked when the action is not disabled and the event is not consumed.
@NonNull javafx.beans.property.BooleanProperty	selectedProperty()	The Boolean that corresponds to the selected state.

Methods inherited from class org.jhotdraw8.application.AbstractDisableable

disabledProperty, disablers

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jhotdraw8.application.action.Action

getId, getLabel, isSelected, setSelected

Methods inherited from interface org.jhotdraw8.fxbase.control.Disableable

addDisabler, disabledProperty, disablers, isDisabled, removeDisabler

Methods inherited from interface org.jhotdraw8.fxbase.beans.PropertyBean

get, getNonNull, getProperty, put, remove, set, setNonNull, valueAt

Property Details

selected

public @NonNull javafx.beans.property.BooleanProperty selectedProperty

Specified by:

selectedProperty in interface Action

Returns:

the property

See Also:

• selectedProperty()

Field Details

properties

protected final javafx.collections.ObservableMap<org.jhotdraw8.fxcollection.typesafekey.Key<?>,Object> properties

Holds the properties.

Constructor Details

AbstractAction

public AbstractAction()

Creates a new instance. Binds disabled to disable.

AbstractAction

public AbstractAction(String id)

Creates a new instance. Binds disabled to disable.

Parameters:

id - the id of the action

Method Details

getProperties

public final @NonNull javafx.collections.ObservableMap<org.jhotdraw8.fxcollection.typesafekey.Key<?>,Object> getProperties()

Specified by:

getProperties in interface PropertyBean

handle

public final void handle(@NonNull javafx.event.ActionEvent event)

Invokes onActionPerformed(javafx.event.ActionEvent) if the action is not disabled and the event is not consumed. Consumes the event after invoking handleActionPerformed.

Specified by:

handle in interface javafx.event.EventHandler<javafx.event.ActionEvent>

Parameters:

event - the action event

onActionPerformed

protected abstract void onActionPerformed(@NonNull javafx.event.ActionEvent event)

This method is invoked when the action is not disabled and the event is not consumed.

Parameters:

event - the action event

selectedProperty

public @NonNull javafx.beans.property.BooleanProperty selectedProperty()

Description copied from interface: Action

The Boolean that corresponds to the selected state. This is typically used only for actions that have a meaningful selection state.

Specified by:

selectedProperty in interface Action

Returns:

the selected property