Package jmri

Interface ConditionalAction

All Known Implementing Classes:

DefaultConditionalAction

public interface ConditionalAction

The consequent of the antecedent of the conditional proposition. The data for the action to be taken when a Conditional calculates to True.

Method Summary

Modifier and Type	Method	Description
java.lang.String	description(boolean triggerType)
void	dispose()	Dispose this ConditionalAction.
int	getActionData()	Integer data for action.
java.lang.String	getActionDataString()
java.lang.String	getActionString()	String data for action.
NamedBean	getBean()
java.lang.String	getDeviceName()	Name of the device or element that is effected.
java.awt.event.ActionListener	getListener()
NamedBeanHandle<?>	getNamedBean()
int	getOption()	Options on when action is taken.
java.lang.String	getOptionString(boolean type)
Sound	getSound()	Get the Sound.
javax.swing.Timer	getTimer()
Conditional.Action	getType()	The consequent device or element type.
java.lang.String	getTypeString()
boolean	isTimerActive()
void	setActionData(int actionData)
void	setActionData(java.lang.String actionData)	Sets action data from user's name for it
void	setActionString(java.lang.String actionString)
void	setDeviceName(java.lang.String deviceName)
void	setListener(java.awt.event.ActionListener listener)
void	setOption(int option)
void	setTimer(javax.swing.Timer timer)
void	setType(java.lang.String type)	Sets type from user's name for it.
void	setType(Conditional.Action type)
void	startTimer()
void	stopTimer()

Method Detail

getActionData

int getActionData()

Integer data for action.

Returns:

the data

getActionDataString

java.lang.String getActionDataString()

getActionString

java.lang.String getActionString()

String data for action.

Returns:

the action String

getDeviceName

java.lang.String getDeviceName()

Name of the device or element that is effected.

Returns:

the name

getOption

int getOption()

Options on when action is taken.

Returns:

the option

getOptionString

java.lang.String getOptionString(boolean type)

Parameters:

type - the type

Returns:

String name of the option for this consequent type

getType

Conditional.Action getType()

The consequent device or element type.

Returns:

the type

getTypeString

java.lang.String getTypeString()

Returns:

String name of this consequent type

setActionData

void setActionData(java.lang.String actionData)

Sets action data from user's name for it

Parameters:

actionData - user name

setActionData

void setActionData(int actionData)

setActionString

void setActionString(java.lang.String actionString)

setDeviceName

void setDeviceName(java.lang.String deviceName)

setOption

void setOption(int option)

setType

void setType(java.lang.String type)

Sets type from user's name for it.

Parameters:

type - name of the type

setType

void setType(Conditional.Action type)

description

java.lang.String description(boolean triggerType)

getTimer

javax.swing.Timer getTimer()

setTimer

void setTimer(javax.swing.Timer timer)

isTimerActive

boolean isTimerActive()

startTimer

void startTimer()

stopTimer

void stopTimer()

getListener

java.awt.event.ActionListener getListener()

setListener

void setListener(java.awt.event.ActionListener listener)

getSound

Sound getSound()

Get the Sound.

Returns:

the sound

getNamedBean

NamedBeanHandle<?> getNamedBean()

getBean

NamedBean getBean()

dispose

void dispose()

Dispose this ConditionalAction.