Package com.iizix.api.vs

Class VSFocusEvent

java.lang.Object
com.iizix.api.BaseEvent<IVSComponent>
com.iizix.api.vs.VSBaseEvent<IVSComponent>
com.iizix.api.vs.VSBaseEventWithTrigger<IVSComponent>
com.iizix.api.vs.VSFocusEvent
All Implemented Interfaces:
IMessageBox
public class VSFocusEvent extends VSBaseEventWithTrigger<IVSComponent>
The VirtualSpace Focus Event is fired when the VirtualSpace focus changes for a component.
Author:
Christopher Mindus

  • Constructor Details Link icon

    • VSFocusEvent Link icon

      public VSFocusEvent(IVSComponent source, IVSComponent opposite, boolean isFocusGained)
      Constructs the event for a change without a trigger source.
      Parameters:
      source - The source.
      opposite - The opposite component losing focus, null for none.
      isFocusGained - Flag indicating focus was gained.
      Throws:
      NullPointerException - If the source is null.

    • VSFocusEvent Link icon

      public VSFocusEvent(IVSComponent source, IVSComponent opposite, boolean isFocusGained, GProp<?> trigger)
      Constructs the event for a change event with a property being the trigger source, e.g. an UIButton or UICheckBox.
      Parameters:
      source - The source.
      opposite - The opposite component losing focus, null for none.
      isFocusGained - Flag indicating focus was gained.
      trigger - The trigger property.

  • Method Details Link icon

    • getSource Link icon

      public IVSComponent getSource()
      Gets the VirtualSpace item that is the source of the event, i.e. the item that gains or loses focus.
      Overrides:
      getSource in class BaseEvent<IVSComponent>
      Returns:
      The VSComponent gaining or losing focus. If this event is fired to a listener on the VirtualSpace, this value can be null when e.g. no one receives focus.

    • getOpposite Link icon

      public IVSComponent getOpposite()
      Gets the opposite component for the focus operation, i.e. if the operation is FocusGained, the opposite component is the one losing focus, and if the operation is FocusLost, the opposite component is the component gaining focus.
      Returns:
      The opposite component, or null for none.

    • isFocusGained Link icon

      public boolean isFocusGained()
      Returns if this is the focus gained operation.
      Returns:
      true if this is focus gained, false for focus lost.

    • isFocusLost Link icon

      public boolean isFocusLost()
      Returns if this is the focus lost operation.
      Returns:
      true if this is focus lost, false for focus gained.

    • paramString Link icon

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