com.ergotech.vib.servers

Class MarqueeServer

java.lang.Object

com.ergotech.vib.servers.DataSource

com.ergotech.vib.servers.SimpleDataSource

com.ergotech.vib.servers.MarqueeServer

public class MarqueeServer
extends SimpleDataSource

This is an example of server for a device that can only have one controller server object for all intances of the data sources (which each has different parameters set). There will be one MarqueeServer for every optional setting in the property lists, but only one MarqueeDeviceServer for all of these. example: m1 MarqueeServer() and m2 MarqueServer() would each produce an instance of MarqueeServer, but only one MarqueeDeviceServer.

See Also:

MarqueeDeviceServer

Nested Class Summary

Nested classes/interfaces inherited from class com.ergotech.vib.servers.SimpleDataSource

SimpleDataSource.NameEditorData

Nested classes/interfaces inherited from class com.ergotech.vib.servers.DataSource

DataSource.Writable

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	cvsRev
java.lang.String	label

Fields inherited from class com.ergotech.vib.servers.SimpleDataSource

customTimer, EXPORT_READ_ONLY, EXPORT_READ_WRITE, NO_EXPORT, requiresSyncWrite, sharedTimer, syncWriteTimeout, timebase

Fields inherited from class com.ergotech.vib.servers.DataSource

autoSuspend, AUTOSUSPEND_DEFAULT, AUTOSUSPEND_NEVER, AUTOSUSPEND_NO_LISTENERS, AUTOSUSPEND_NO_LISTENERS_AND_NO_SOURCES, colorHi, colorHiHi, colorLo, colorLoLo, colorNormal, connectors, consoleLogger, currentColor, currentValue, debugLevel, dontConnect, gwtLog, hardSuspended, popupLogger, PRIMARYOUTPORTNAME, sendColors, stopped, suspended, timedPopupLogger, traceLogger, valueHi, valueHiHi, valueLo, valueLoLo

Constructor Summary

Constructors

Constructor and Description
MarqueeServer() The constructor will make sure there is a MarqueeDeviceServer created then set the default label and timebase.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getLabel() This will return the current label without any characters switched.
void	refreshCurrentValue() This method will be called on the timebase.
void	setLabel(java.lang.String newValue) This will update (change) the string being displayed as a marquee output.
void	setOption(java.lang.String newValue) This method is called for every single entry in the parameter list.
void	setSuspendedInternal(boolean newValue) This will be called after all the parameters are set.
void	start() Starts the device server.

Methods inherited from class com.ergotech.vib.servers.SimpleDataSource

addConnector, addConnector, addDataSource, addPropertyChangeListener, addValueChangedListener, addVetoableChangeListener, authenticatedClientRequest, clientRequest, clientResponse, destroy, determineSuspendedStatus, getClassLicenseManager, getContainer, getCustomTimer, getDataSource, getDataSources, getDisplayName, getExportCriteria, getName, getOutPortNames, getPullFromServers, getPushData, getPushName, getPushToServers, getServerListData, getTimebase, getTrace, isActive, isScreenLocal, removeConnector, removeDataSource, removePropertyChangeListener, removeValueChangedListener, removeVetoableChangeListener, requestSyncWrite, setAutoSuspend, setClassLicenseManager, setContainer, setCustomTimer, setDataSourceName, setExportCriteria, setName, setPullFromServers, setPushData, setPushName, setPushToServers, setScreenLocal, setServerListData, setTimebase, setTrace, setValueObject, stop, tick, toString, VIBEvent

Methods inherited from class com.ergotech.vib.servers.DataSource

addVIBEventListener, checkScript, executeInScriptInternal, executeScript, executeScriptInternal, executeScriptInternal, getAutoSuspend, getBooleanValue, getBoolValue, getColorHi, getColorHiHi, getColorLo, getColorLoLo, getColorNormal, getConnectors, getConsoleLogger, getCurrentColor, getDataSourceName, getDoubleValue, getFloatValue, getGWTLogger, getIncomingValueObject, getInScript, getIntValue, getLongValue, getParent, getPopupLogger, getScript, getSendColors, getSources, getStringValue, getSyncWriteTimeout, getTimedPopupLogger, getTraceLogger, getValueHi, getValueHiHi, getValueLo, getValueLoLo, getValueObject, init, isHardSuspended, isRunning, isSendOnlyChangedValuesDefault, isSuspended, logException, logGWT, logGWT, logMessage, logTrace, n2sortConnectors, popupMessage, post, removeConnector, removeVIBEventListener, replaceConnectors, scriptExtensionSubstition, setColorHi, setColorHiHi, setColorLo, setColorLoLo, setColorNormal, setConsoleLogger, setGWTLogger, setHardSuspended, setInScript, setParent, setPopupLogger, setScript, setSendColors, setSendOnlyChangedValuesDefault, setSyncWriteTimeout, setTimedPopupLogger, setTraceLogger, setValueHi, setValueHiHi, setValueLo, setValueLoLo, updateColor, updateListeners, updateListeners, updateListeners, whoAmI

Methods inherited from class java.lang.Object

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

Field Detail

cvsRev

public static final java.lang.String cvsRev

See Also:

Constant Field Values

label

public java.lang.String label

Constructor Detail

MarqueeServer

public MarqueeServer()

The constructor will make sure there is a MarqueeDeviceServer created then set the default label and timebase. Notice that this does not start a timer. This will be done in the setSuspendedInternal method.

Method Detail

getLabel

public java.lang.String getLabel()

This will return the current label without any characters switched.

Returns:

the current label

See Also:

Writing VIB Data Sources: Get/Set Methods, setLabel(java.lang.String)

refreshCurrentValue

public void refreshCurrentValue()

This method will be called on the timebase. This will ask the MarqueeDeviceServer for the new stringValue. All connectors are updated.

Overrides:

refreshCurrentValue in class SimpleDataSource

setLabel

public void setLabel(java.lang.String newValue)

This will update (change) the string being displayed as a marquee output.

Parameters:

newValue - the string being displayed as a marquee output

See Also:

Writing VIB Data Sources: Get/Set Methods, getLabel()

setOption

public void setOption(java.lang.String newValue)

This method is called for every single entry in the parameter list. So if someone attaches with a parameter list of m1 MarqueeServer ("one") then the string 'one' will be sent here. NOTICE: This can be called multiple times in one parameter list.

Parameters:

newValue - the new String value to display

setSuspendedInternal

public void setSuspendedInternal(boolean newValue)

This will be called after all the parameters are set. This will register with the MarqueeDeviceServer and start the timer.

Parameters:

newValue - a true registers and starts the timer

See Also:

MarqueeDeviceServer.registerString(java.lang.String, com.ergotech.vib.servers.DataSource)

start

public void start()
           throws BadParameterException,
                  VIBUpdateFailedException

Starts the device server.

Overrides:

start in class SimpleDataSource

Throws:

BadParameterException

VIBUpdateFailedException

See Also:

SimpleDataSource.start()