Package com.iizix.api.ui

Class UIActionEvent

java.lang.Object
com.iizix.api.BaseEvent<UICOMP>
com.iizix.api.ui.UIBaseEvent<IUIAction>
com.iizix.api.ui.UIActionEvent
All Implemented Interfaces:
IMessageBox
public class UIActionEvent extends UIBaseEvent<IUIAction>
The UI component Action Event.
Author:
Christopher Mindus

  • Constructor Details

    • UIActionEvent

      public UIActionEvent(IUIAction source)
      Constructs the event for an action without a trigger source.
      Parameters:
      source - The source.
      Throws:
      NullPointerException - If the source is null.

    • UIActionEvent

      public UIActionEvent(IUIAction source, GProp<?> trigger)
      Constructs the event for an action with a property being the trigger source, e.g. an UIButton.
      Parameters:
      source - The source.
      trigger - The trigger property.

    • UIActionEvent

      public UIActionEvent(IUIAction source, GProp<?> trigger, UIComp contextComponent)
      Constructs the event for an action with a property being the trigger source, e.g. an UIButton.
      Parameters:
      source - The source.
      trigger - The trigger property.
      contextComponent - The context component causing the event, used for context menus.

  • Method Details

    • getTrigger

      public GProp<?> getTrigger()
      Gets the trigger property being the source of the event.
      Returns:
      An instance of e.g. an UIButton or null if the trigger is not a property.

    • getSource

      public IUIAction getSource()
      Gets the UI component Action that is the source of the event.
      Overrides:
      getSource in class BaseEvent<IUIAction>

    • getContextComponent

      public UIComp getContextComponent()
      The context UI component that caused the event, when the event is generated from a context menu.
      Returns:
      The UI component, null if not originating from a context menu.

    • paramString

      protected String paramString()
      Gets the parameter string.
      Overrides:
      paramString in class BaseEvent<IUIAction>