de.cau.cs.kieler.core.kivi.triggers
Class ButtonTrigger.ButtonState

java.lang.Object
  extended by de.cau.cs.kieler.core.kivi.AbstractTriggerState
      extended by de.cau.cs.kieler.core.kivi.triggers.ButtonTrigger.ButtonState
All Implemented Interfaces:
ITriggerState
Enclosing class:
ButtonTrigger

public static class ButtonTrigger.ButtonState
extends AbstractTriggerState

Contains information about the last view management button pressed.

Rating red

Constructor Summary
ButtonTrigger.ButtonState()
          Default constructor.
ButtonTrigger.ButtonState(IEditorPart editorPart, String id, Map<?,?> params, boolean pushed)
          Create a new button state for the given editor and button id.
 
Method Summary
 String getButtonId()
          Get the id for the button.
 IEditorPart getEditor()
          Get the active editor associated with the button.
 Map<?,?> getParameters()
          Get the parameters of the button.
 Class<? extends ITrigger> getTriggerClass()
          Get the trigger class associated with this trigger state.
 boolean isPushedIn()
          Check if a toggle button is pushed in or not.
 
Methods inherited from class de.cau.cs.kieler.core.kivi.AbstractTriggerState
finish, getKeyClass, getSequenceNumber, merge
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ButtonTrigger.ButtonState

public ButtonTrigger.ButtonState()
Default constructor.


ButtonTrigger.ButtonState

public ButtonTrigger.ButtonState(IEditorPart editorPart,
                                 String id,
                                 Map<?,?> params,
                                 boolean pushed)
Create a new button state for the given editor and button id.

Parameters:
editorPart - the active editor
id - the button id
params - a map of button parameters
pushed - true if a toggle button is pushed in
Method Detail

getEditor

public IEditorPart getEditor()
Get the active editor associated with the button.

Returns:
the active editor

getButtonId

public String getButtonId()
Get the id for the button.

Returns:
the id

getParameters

public Map<?,?> getParameters()
Get the parameters of the button.

Returns:
a map of parameters

isPushedIn

public boolean isPushedIn()
Check if a toggle button is pushed in or not.

Returns:
true if pushed in

getTriggerClass

public Class<? extends ITrigger> getTriggerClass()
Get the trigger class associated with this trigger state.

Returns:
the trigger class