Class UIBackEvent

java.lang.Object
com.iizix.api.BaseEvent<UIPanelBase>
com.iizix.api.ui.UIBaseEvent<UIPanelBase>
com.iizix.api.ui.UIBackEvent
All Implemented Interfaces:
IMessageBox
public class UIBackEvent extends UIBaseEvent<UIPanelBase>
The UI Back Event.
Author:
Christopher Mindus

  • Constructor Details

    • UIBackEvent

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

    • UIBackEvent

      public UIBackEvent(UIPanelBase source, boolean keyboard)
      Constructs the event for a Back the client sent as a key: the Escape key of a desktop keyboard, which the client reports to the top-most panel like the device's Back button (CC-FIX-SIGNIN-CANCEL-BACK). A panel's handler may treat the two alike; a panel without a handler consumes the key and performs no history operation.
      Parameters:
      source - The source.
      keyboard - true for the Escape key, false for a Back button.
      Throws:
      NullPointerException - If the source is null.

  • Method Details

    • isKeyboard

      public boolean isKeyboard()
      Checks whether the event came from the Escape key of a keyboard rather than the device's or the Browser's Back button.
      Returns:
      true for the Escape key, false for a Back button.

    • getSource

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