rs.sol.soloist.server.guiconfiguration.components
Class GUITimerComponent

java.lang.Object
  rs.sol.soloist.server.uml.commonimplementation.runtime._ClassifierInstance
      rs.sol.soloist.server.uml.commonimplementation.runtime._ClassInstance
          rs.sol.soloist.server.javaimpl.runtime.SOLoistClassInstance
              rs.sol.soloist.server.builtindomains.common.ObjectOfClass
                  rs.sol.soloist.server.guiconfiguration.construction.GUIComponent
                      rs.sol.soloist.server.guiconfiguration.components.GUITimerComponent

All Implemented Interfaces:

IElementPresentationProvider, IUpdatable, rs.sol.soloist.server.uml.concepts.IElement, IClassifierInstance, IClassInstance, IRTElement

public class GUITimerComponent
extends GUIComponent

A widget that displays and counts-down the time. The initial time interval can be set using setTime(String) method.

This widget's input pins start (ipStart() method), stop (ipStop() method), and pause (ipPause() method) control its behavior in the run-time.

After time elapses, this widget fires event on its timeout (opTimeout() method) output pin.

Author:

SOL Expert Group

Nested Class Summary

static class	GUITimerComponent.FQPropertyNames Deprecated. Not for public use.
static class	GUITimerComponent.PROPERTIES Deprecated. Not for public use.

Field Summary

static IClass	CLASSIFIER UML class reference
static java.lang.String	FQ_TYPE_NAME Fully qualified UML class name
IAttributeValue<Text>	pause Deprecated. Not for public use.
IAttributeValue<Integer>	reportOnEvery Deprecated. Not for public use.
IAttributeValue<Text>	start Deprecated. Not for public use.
IAttributeValue<Boolean>	startOnInit Deprecated. Not for public use.
IAttributeValue<Text>	stop Deprecated. Not for public use.
IAttributeValue<Time>	time Deprecated. Not for public use.
IAttributeValue<Text>	timeout Deprecated. Not for public use.
IAttributeValue<Text>	timeToGo Deprecated. Not for public use.

Fields inherited from class rs.sol.soloist.server.guiconfiguration.construction.GUIComponent

addStyle, context, description, enabled, init, inputBindings, layoutData, logger, name, outputBindings, ownerTable, parent, removeStyle, show, showInParent, styleName, tooltip, visible

Constructor Summary

GUITimerComponent()

Method Summary

void	constructor() The domain-specific constructor of the Classifier.
static GUITimerComponent	create(GUIContainerComponent parent, Time time) Returns new GUITimerComponent with the given initial time and assigns it to the given parent.
static GUITimerComponent	create(GUIContainerComponent parent, Time time, Integer reportOnEvery, LayoutData layoutData) Deprecated. Not for public use.
static GUITimerComponent	create(GUIContainerComponent parent, Time time, LayoutData layoutData) Returns new GUITimerComponent with the given initial time, places it in the parent's layout according to the given LayoutData, and assigns it to the given parent.
int	getReportOnEvery() Returns the number of seconds that determines the report period of this widget.
boolean	getStartOnInit() Returns whether this widget will start counting down immediately after it gets initialized or not.
int	getTime() Returns the initial count-down time interval.
ISlot<?>	ipPause() Returns the pause input pin; when event occurs, the count-down pauses.
ISlot<?>	ipStart() Returns the start input pin; when event occurs, the count-down starts.
ISlot<?>	ipStop() Returns the stop input pin; when event occurs, the count-down stops.
ISlot<?>	ipTime() Returns the time input pin; when event occurs, the content from the binding message is used to set new count-down time of this widget.
ISlot<?>	opTimeout() Returns the timeout output pin; when the count-down finishes, this widget signals other interested widgets by providing an empty binding message on this pin.
ISlot<?>	opTimeToGo() Returns the timeToGo output pin; during the count-down period, on each number of seconds (defined by setReportOnEvery(int) method), this widget provides a binding message with the remaining time on this pin.
void	setReportOnEvery(int reportOnEvery) Sets the number of seconds that determines the report period of this widget.
void	setStartOnInit(boolean startOnInit) Sets whether this widget will start counting down immediately after it gets initialized or not.
void	setTime(java.lang.String time) Sets the initial count-down time interval.

Methods inherited from class rs.sol.soloist.server.guiconfiguration.construction.GUIComponent

addStyleNames, addValueToSlot, clearSlot, clone, createInfo, createInfoAlreadyValidated, destructor, fillElementInfo, getApplication, getCommands, getCommands, getCommonOwner, getContext, getDescription, getDescrString, getDragIcon, getEnabled, getFeature, getFeature, getInputBindings, getInputPin, getInputPins, getLabelString, getLargeIcon, getLayoutData, getName, getNameString, getOutputPin, getOutputPins, getOwner, getParts, getSetting, getSmallIcon, getStyle, getSubnodes, getTooltip, getTooltipString, getTypeString, getVisible, handle, ipAddStyle, ipEnabled, ipInit, ipRemoveStyle, ipShow, ipShowInParent, ipVisible, isInputPin, isOutputPin, putFeatureInfo, readElement, readElements, readSlot, readSlotAsInfo, readSubnodes, removeValueFromSlot, setCellAlignment, setCellSize, setCellStyle, setCenter, setContext, setDescription, setDirectionAndSize, setEnabled, setLayoutData, setLeftRightWidth, setName, setRowColumn, setRowColumn, setSize, setSlot, setSlot, setStyle, setTooltip, setTopBottomHeight, setVisible, setXY, toTranslateDescriptors, translatePinName, updateInfo, validate, validateParts, validateParts

Methods inherited from class rs.sol.soloist.server.javaimpl.runtime.SOLoistClassInstance

destroy, equals, getAssociationEndInstance, getAssociationEndInstances, getAttributeValue, getAttributeValues, getMyClass, getMyID, getSlot, getSlot, getSlots, getUMLClass, hashCode, isMarkedAsDeleted, toString

Methods inherited from class rs.sol.soloist.server.uml.commonimplementation.runtime._ClassInstance

accept, accept, exists, getAssociationEndInstance, getAssociationEndInstance, getAssociationEndInstance, getClassifier, hasIdentity, isClassInstance, isDataTypeInstance, isEqualTo, makeClone, markAsDeleted

Methods inherited from class rs.sol.soloist.server.uml.commonimplementation.runtime._ClassifierInstance

conformsTo, copySlots, copySlots, getAttributeValue, getAttributeValue, getAttributeValue, getClassifierFQName, getClassifierUQName, getFirstCommonGeneralizer, getFirstCommonGeneralizerFQName, getFirstCommonGeneralizerUQName, getMElement, getSlot, getSlot, isDirectInstanceOf, isDirectInstanceOf, isInstanceOf, isInstanceOf, isKindOf, isModelElement, isRTElement

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface rs.sol.soloist.server.uml.concepts.runtime.IClassifierInstance

conformsTo, copySlots, copySlots, getAttributeValue, getAttributeValue, getClassifierFQName, getClassifierUQName, getFirstCommonGeneralizer, getFirstCommonGeneralizerFQName, getFirstCommonGeneralizerUQName, getSlot, getSlot, isDirectInstanceOf, isDirectInstanceOf, isInstanceOf, isInstanceOf

Methods inherited from interface rs.sol.soloist.server.uml.concepts.runtime.IRTElement

getMElement

Methods inherited from interface rs.sol.soloist.server.uml.concepts.IElement

isKindOf, isModelElement, isRTElement

Field Detail

startOnInit

@Deprecated
public final IAttributeValue<Boolean> startOnInit

Deprecated. Not for public use.

reportOnEvery

@Deprecated
public final IAttributeValue<Integer> reportOnEvery

Deprecated. Not for public use.

time

@Deprecated
public final IAttributeValue<Time> time

Deprecated. Not for public use.

start

@Deprecated
public final IAttributeValue<Text> start

Deprecated. Not for public use.

stop

@Deprecated
public final IAttributeValue<Text> stop

Deprecated. Not for public use.

pause

@Deprecated
public final IAttributeValue<Text> pause

Deprecated. Not for public use.

timeout

@Deprecated
public final IAttributeValue<Text> timeout

Deprecated. Not for public use.

timeToGo

@Deprecated
public final IAttributeValue<Text> timeToGo

Deprecated. Not for public use.

FQ_TYPE_NAME

public static final java.lang.String FQ_TYPE_NAME

Fully qualified UML class name

See Also:

Constant Field Values

CLASSIFIER

public static final IClass CLASSIFIER

UML class reference

Constructor Detail

GUITimerComponent

public GUITimerComponent()

Method Detail

constructor

public void constructor()

Description copied from interface: IClassifierInstance

The domain-specific constructor of the Classifier.

Specified by:

constructor in interface IClassifierInstance

Overrides:

constructor in class GUIComponent

create

public static GUITimerComponent create(GUIContainerComponent parent,
                                       Time time)

Returns new GUITimerComponent with the given initial time and assigns it to the given parent.

Parameters:

parent - the parent GUIContainerComponent widget

time - the initial time interval to count down

Returns:

the new GUITimerComponent

create

public static GUITimerComponent create(GUIContainerComponent parent,
                                       Time time,
                                       LayoutData layoutData)

Returns new GUITimerComponent with the given initial time, places it in the parent's layout according to the given LayoutData, and assigns it to the given parent.

Parameters:

parent - the parent GUIContainerComponent widget

time - the initial time interval to count down

layoutData - the layout data of the new timer

Returns:

the new GUITimerComponent

ipTime

public ISlot<?> ipTime()

Returns the time input pin; when event occurs, the content from the binding message is used to set new count-down time of this widget.

Returns:

the time input pin

See Also:

GUIComponentBinding

ipStart

public ISlot<?> ipStart()

Returns the start input pin; when event occurs, the count-down starts.

The content of the binding message accepted on this pin is of no importance. Only event is what matters.

Returns:

the start input pin

See Also:

GUIComponentBinding

ipStop

public ISlot<?> ipStop()

Returns the stop input pin; when event occurs, the count-down stops.

The content of the binding message accepted on this pin is of no importance. Only event is what matters.

Returns:

the stop input pin

See Also:

GUIComponentBinding

ipPause

public ISlot<?> ipPause()

Returns the pause input pin; when event occurs, the count-down pauses.

The content of the binding message accepted on this pin is of no importance. Only event is what matters.

Returns:

the pause input pin

See Also:

GUIComponentBinding

opTimeout

public ISlot<?> opTimeout()

Returns the timeout output pin; when the count-down finishes, this widget signals other interested widgets by providing an empty binding message on this pin.

Returns:

the timeout output pin

See Also:

GUIComponentBinding

opTimeToGo

public ISlot<?> opTimeToGo()

Returns the timeToGo output pin; during the count-down period, on each number of seconds (defined by setReportOnEvery(int) method), this widget provides a binding message with the remaining time on this pin.

Returns:

the timeToGo output pin

See Also:

GUIComponentBinding

getTime

public int getTime()

Returns the initial count-down time interval.

Returns:

the initial count-down time interval

See Also:

setTime(String)

setTime

public void setTime(java.lang.String time)

Sets the initial count-down time interval.

Parameters:

time - the initial count-down time interval

getStartOnInit

public boolean getStartOnInit()

Returns whether this widget will start counting down immediately after it gets initialized or not.

Returns:

whether this widget will start counting down immediately after it gets initialized or not

See Also:

setStartOnInit(boolean)

setStartOnInit

public void setStartOnInit(boolean startOnInit)

Sets whether this widget will start counting down immediately after it gets initialized or not.

Parameters:

startOnInit - a boolean that tells whether this widget will start counting down immediately after it gets initialized or not

getReportOnEvery

public int getReportOnEvery()

Returns the number of seconds that determines the report period of this widget.

Returns:

the number of seconds that determines the report period

See Also:

setReportOnEvery(int)

setReportOnEvery

public void setReportOnEvery(int reportOnEvery)

Sets the number of seconds that determines the report period of this widget. The report contains the remaining time during the count-down period.

Parameters:

reportOnEvery -

create

@Deprecated
public static GUITimerComponent create(GUIContainerComponent parent,
                                                  Time time,
                                                  Integer reportOnEvery,
                                                  LayoutData layoutData)

Deprecated. Not for public use.