Module org.jhotdraw8.application
Package org.jhotdraw8.application.action

Interface Action

All Superinterfaces:
Disableable, javafx.event.EventHandler<javafx.event.ActionEvent>, EventListener, PropertyBean
All Known Implementing Classes:
AboutAction, AbstractAction, AbstractActivityAction, AbstractApplicationAction, AbstractFindAction, AbstractFocusOwnerAction, AbstractOpenFileAction, AbstractPreferencesAction, AbstractSaveFileAction, AbstractSaveUnsavedChangesAction, AbstractSelectionAction, BrowseFileDirectoryAction, ClearFileAction, ClearRecentFilesMenuAction, ClearSelectionAction, CloseFileAction, CopyAction, CutAction, DeleteAction, DuplicateAction, ExitAction, ExportFileAction, NewFileAction, NewWindowAction, OpenFileAction, OpenRecentFileAction, PasteAction, PrintFileAction, RedoAction, RevertFileAction, SaveFileAction, SaveFileAsAction, ScreenMenuBarProxyAction, SelectAllAction, ToggleBooleanAction, ToggleViewPropertyAction, UndoAction
public interface Action extends javafx.event.EventHandler<javafx.event.ActionEvent>, PropertyBean, Disableable
Action.
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 interface org.jhotdraw8.fxbase.control.Disableable

    disabled

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.jhotdraw8.fxcollection.typesafekey.Key<javafx.scene.input.KeyCombination>
    ACCELERATOR_KEY
    The key used for storing a KeyCombination to be used as the accelerator for the action.
    static final org.jhotdraw8.fxcollection.typesafekey.NullableKey<String>
    ID_KEY
    The key used for storing the action in an action map, and for accessing resources in resource bundles.
    static final org.jhotdraw8.fxcollection.typesafekey.NullableKey<String>
    LABEL
    The key used for storing the String name for the action, used for a menu or button.
    static final org.jhotdraw8.fxcollection.typesafekey.Key<javafx.scene.Node>
    LARGE_ICON_KEY
    The key used for large icon, such as ImageView.
    static final org.jhotdraw8.fxcollection.typesafekey.NullableKey<String>
    LONG_DESCRIPTION
    The key used for storing a longer String description for the action, could be used for context-sensitive help.
    static final org.jhotdraw8.fxcollection.typesafekey.Key<javafx.scene.input.KeyCombination>
    MNEMONIC_KEY
    The key used for storing a KeyCombination to be used as the mnemonic for the action.
    static final String
    SELECTED_PROPERTY
    The selected property.
    static final org.jhotdraw8.fxcollection.typesafekey.NullableKey<String>
    SHORT_DESCRIPTION
    The key used for storing a short String description for the action, used for tooltip text.
    static final org.jhotdraw8.fxcollection.typesafekey.Key<javafx.scene.Node>
    SMALL_ICON
    The key used for storing a small icon, such as ImageView.

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

    DISABLED_PROPERTY

  • Method Summary

    Modifier and Type
    Method
    Description
    default @Nullable String
    getId()
    The name of the action for use in action maps and for resource bundles.
    default @Nullable String
    getLabel()
    The localized name of the action for use in controls.
    default boolean
    isSelected()
    Gets the value of the selected property.
    @NonNull javafx.beans.property.BooleanProperty
    selectedProperty()
    The Boolean that corresponds to the selected state.
    default void
    setSelected(boolean newValue)
    Sets the value of the selected property.

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

    addDisabler, disabledProperty, disablers, isDisabled, removeDisabler

    Methods inherited from interface javafx.event.EventHandler

    handle

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

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

  • Property Details

  • Field Details

    • ID_KEY

      static final org.jhotdraw8.fxcollection.typesafekey.NullableKey<String> ID_KEY
      The key used for storing the action in an action map, and for accessing resources in resource bundles.

    • LABEL

      static final org.jhotdraw8.fxcollection.typesafekey.NullableKey<String> LABEL
      The key used for storing the String name for the action, used for a menu or button.

    • SHORT_DESCRIPTION

      static final org.jhotdraw8.fxcollection.typesafekey.NullableKey<String> SHORT_DESCRIPTION
      The key used for storing a short String description for the action, used for tooltip text.

    • LONG_DESCRIPTION

      static final org.jhotdraw8.fxcollection.typesafekey.NullableKey<String> LONG_DESCRIPTION
      The key used for storing a longer String description for the action, could be used for context-sensitive help.

    • SMALL_ICON

      static final org.jhotdraw8.fxcollection.typesafekey.Key<javafx.scene.Node> SMALL_ICON
      The key used for storing a small icon, such as ImageView. This is typically used with menus.

    • ACCELERATOR_KEY

      static final org.jhotdraw8.fxcollection.typesafekey.Key<javafx.scene.input.KeyCombination> ACCELERATOR_KEY
      The key used for storing a KeyCombination to be used as the accelerator for the action.

    • MNEMONIC_KEY

      static final org.jhotdraw8.fxcollection.typesafekey.Key<javafx.scene.input.KeyCombination> MNEMONIC_KEY
      The key used for storing a KeyCombination to be used as the mnemonic for the action.
      Since:
      1.3

    • LARGE_ICON_KEY

      static final org.jhotdraw8.fxcollection.typesafekey.Key<javafx.scene.Node> LARGE_ICON_KEY
      The key used for large icon, such as ImageView. This is typically used by buttons.

    • SELECTED_PROPERTY

      static final String SELECTED_PROPERTY
      The selected property.
      See Also:

  • Method Details

    • getLabel

      default @Nullable String getLabel()
      The localized name of the action for use in controls.
      Returns:
      The name

    • getId

      default @Nullable String getId()
      The name of the action for use in action maps and for resource bundles.
      Returns:
      The instance

    • selectedProperty

      @NonNull javafx.beans.property.BooleanProperty selectedProperty()
      The Boolean that corresponds to the selected state. This is typically used only for actions that have a meaningful selection state.
      Returns:
      the property
      See Also:

    • setSelected

      default void setSelected(boolean newValue)
      Sets the value of the selected property.
      Property description:
      The Boolean that corresponds to the selected state. This is typically used only for actions that have a meaningful selection state.
      Parameters:
      newValue - the value for the selected property
      See Also:

    • isSelected

      default boolean isSelected()
      Gets the value of the selected property.
      Property description:
      The Boolean that corresponds to the selected state. This is typically used only for actions that have a meaningful selection state.
      Returns:
      the value of the selected property
      See Also: