com.jbbres.lib.actions.tools.elements
Class ActionUIEvent

java.lang.Object
  java.util.EventObject
      com.jbbres.lib.actions.tools.elements.ActionUIEvent

All Implemented Interfaces:

java.io.Serializable

public class ActionUIEvent
extends java.util.EventObject

A semantic event which indicates that a AbstractActionUI event occurred.

This event is generated by a AbstractActionUI when the user interact with the user interface.
The event is passed to every ActionUIListener object that registered to receive such events using AbstractActionUI's addActionUIListener(ActionUIListener) method.

The object that implements the ActionUIListener interface gets this ActionUIEvent when the event occurs.

Since:

1.0.0

Version:

1.0.0

Author:

Jean-Baptiste Bres

See Also:

Serialized Form

Constructor Summary

ActionUIEvent(AbstractActionUI source, boolean showWhenRun, java.lang.String prompt)
Instantiates a new event.

Method Summary

java.lang.String	getPrompt() Returns the new "Show When Run" prompt text.
boolean	isShownWhenRun() When the Show When Run feature is on, this method returns the current state of the "Show When Running the Workflow" check box.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ActionUIEvent

public ActionUIEvent(AbstractActionUI source,
                     boolean showWhenRun,
                     java.lang.String prompt)

Instantiates a new event.

Parameters:

source - - The AbstractActionUI on which the event initially occurred.

showWhenRun - - new value of the "Show when run" check box.

prompt - - new value of the prompt.

Method Detail

isShownWhenRun

public boolean isShownWhenRun()

When the Show When Run feature is on, this method returns the current state of the "Show When Running the Workflow" check box.

Returns:

true if the "Show When Running the Workflow" check box is selected; false otherwise

getPrompt

public java.lang.String getPrompt()

Returns the new "Show When Run" prompt text.

Returns:

the new "Show When Run" prompt text.