Skip navigation links

oracle.adf.view.rich.model
Class TrainStopModel

java.lang.Object
oracle.adf.view.rich.model.TrainStopModel

public abstract class TrainStopModel

extends java.lang.Object

Represents a model for a train stop within the train component. Developers are not required to extend this class, as long as the object that represents a train stop has the same EL structure.

Field Summary

static java.lang.String	MESSAGE_TYPE_CONFIRMATION
static java.lang.String	MESSAGE_TYPE_ERROR
static java.lang.String	MESSAGE_TYPE_INFO
static java.lang.String	MESSAGE_TYPE_NONE
static java.lang.String	MESSAGE_TYPE_WARNING

Constructor Summary

TrainStopModel()

Method Summary

abstract java.lang.String	action() Returns the logical outcome associated with clicking on a train stop (which may be null).
java.lang.String	getMessageType() Returns "none" as the default message type for a stop.
java.lang.String	getShortDescription() Return a short description for the stop.
abstract java.lang.String	getTextAndAccessKey() Return the label of the stop alongwith with the accessKey character to use.
abstract boolean	isDisabled() Return a flag indicating whether the stop needs to be disabled.
boolean	isImmediate() Return a flag to inidicate whether or not data validations need to occur.
boolean	isShowRequired() Return a true if the stop should show a required indicator (usually used when there are one more required fields).
abstract boolean	isVisited() Return a flag to indicate whether the stop has been visited before.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MESSAGE_TYPE_NONE

public static final java.lang.String MESSAGE_TYPE_NONE

See Also:

Constant Field Values

MESSAGE_TYPE_INFO

public static final java.lang.String MESSAGE_TYPE_INFO

See Also:

Constant Field Values

MESSAGE_TYPE_CONFIRMATION

public static final java.lang.String MESSAGE_TYPE_CONFIRMATION

See Also:

Constant Field Values

MESSAGE_TYPE_WARNING

public static final java.lang.String MESSAGE_TYPE_WARNING

See Also:

Constant Field Values

MESSAGE_TYPE_ERROR

public static final java.lang.String MESSAGE_TYPE_ERROR

See Also:

Constant Field Values

Constructor Detail

TrainStopModel

public TrainStopModel()

Method Detail

action

public abstract java.lang.String action()

Returns the logical outcome associated with clicking on a train stop (which may be null). The outcome will be used to navigate the user to the next stop within the train.

getMessageType

public java.lang.String getMessageType()

Returns "none" as the default message type for a stop. Implementations can override this to return a different message type. Supported types are error, info, confirmation and warning. Any other message type will be ignored.

getShortDescription

public java.lang.String getShortDescription()

Return a short description for the stop. This text is commonly used by to display tooltip help text.

getTextAndAccessKey

public abstract java.lang.String getTextAndAccessKey()

Return the label of the stop alongwith with the accessKey character to use. For example, if the stop label is "Step One" and the accessKey is 'O', the return value like "Step &One" will set the text to "Step One" and the access key to 'O'. If no accessKey is required, the label alone can be returned.

isDisabled

public abstract boolean isDisabled()

Return a flag indicating whether the stop needs to be disabled. A true value renders the stop read-only and not clickable.

isImmediate

public boolean isImmediate()

Return a flag to inidicate whether or not data validations need to occur. When true, the default ActionListener provided by the JavaServer Faces implementation will be executed immediately (that is, during Apply Request Values phase of the request processing lifecycle), rather than waiting until the Invoke Application phase. Default value is false.

isShowRequired

public boolean isShowRequired()

Return a true if the stop should show a required indicator (usually used when there are one more required fields). Default value is false.

isVisited

public abstract boolean isVisited()

Return a flag to indicate whether the stop has been visited before.

Skip navigation links