Package io.guise.framework.model

Interface ActionModel

All Superinterfaces:
ActionListenable, Model, com.globalmentor.beans.PropertyBindable, com.globalmentor.beans.PropertyConstrainable
All Known Subinterfaces:
ActionControl, ActionPrototype, ActionValueControl<V>, ButtonControl, LinkControl, Menu, SelectActionControl, SelectButtonControl, SelectLinkControl, ToolButtonControl, TreeModel, TreeNodeModel<V>
All Known Implementing Classes:
AbstractActionControl, AbstractActionPrototype, AbstractActionValueControl, AbstractBooleanSelectActionControl, AbstractButtonControl, AbstractLinkControl, AbstractMenu, AbstractSelectActionControl, AbstractSelectActionValueControl, AccordionMenu, BooleanSelectButton, BooleanSelectLink, BooleanSelectToolButton, Button, DefaultActionModel, DefaultTreeModel, DefaultTreeNodeModel, DropMenu, DummyTreeNodeModel, DynamicTreeNodeModel, HeadingLink, ImageActionControl, ImageBooleanSelectActionControl, Link, MenuPrototype, NavigateActionPrototype, PendingImageActionControl, ProxyActionPrototype, SelectButton, SelectLink, TaskStateSelectLink, ToolButton, TreeControl, ValueSelectButton, ValueSelectLink
public interface ActionModel extends Model, ActionListenable
A model for a potential action.
Author:
Garret Wilson

  • Method Summary

    Modifier and Type
    Method
    Description
    Iterable<ActionListener>
    getActionListeners()
     
    void
    performAction()
    Performs the action with default force and default option.
    void
    performAction(int force, int option)
    Performs the action with the given force and option.

    Methods inherited from interface io.guise.framework.event.ActionListenable

    addActionListener, removeActionListener

    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

  • Method Details

    • getActionListeners

      Iterable<ActionListener> getActionListeners()
      Returns:
      all registered action listeners.

    • performAction

      void performAction()
      Performs the action with default force and default option. An ActionEvent is fired to all registered ActionListeners. This method delegates to performAction(int, int).

    • performAction

      void performAction(int force, int option)
      Performs the action with the given force and option. An ActionEvent is fired to all registered ActionListeners.
      Parameters:
      force - The zero-based force, such as 0 for no force or 1 for an action initiated by from a mouse single click.
      option - The zero-based option, such as 0 for an event initiated by a mouse left button click or 1 for an event initiated by a mouse right button click.