org.lsst.ccs.gconsole.jas3

Class Jas3Console

java.lang.Object

org.lsst.ccs.Agent

org.lsst.ccs.Subsystem

org.lsst.ccs.gconsole.Console

org.lsst.ccs.gconsole.jas3.Jas3Console

All Implemented Interfaces:

org.lsst.ccs.messaging.CommandExecutor

public class Jas3Console
extends Console

Jas3-based Graphical Console implementation.

Author:

onoprien

Nested Class Summary

Nested classes/interfaces inherited from class org.lsst.ccs.gconsole.Console

Console.PropertyListener

Nested classes/interfaces inherited from class org.lsst.ccs.Agent

org.lsst.ccs.Agent.RunningCommand

Field Summary

Fields inherited from class org.lsst.ccs.Agent

commandExecutorLock, currentAction, currentQueries, currentSignals, heartbeatPublisher, innerStateLock, logBusHandler, runtimeInfoPublisher

Constructor Summary

Constructors

Constructor and Description
Jas3Console()

Method Summary

Modifier and Type	Method and Description
void	addMenu(Action action, String owner, String... locations) Adds an item to the graphical console menu bar.
void	addPreference(String[] path, String group, String format) Adds a setter for one or more previously defined properties to the preferences menu.
void	addProperty(String key, Object defaultValue) Defines a console property with the specified default value.
void	addPropertyListener(Console.PropertyListener listener, String filter) Registers a listener that will be notified of property changes.
void	error(String message) Notifies the user of an application error.
void	error(String message, Exception x) Notifies the user of an application error.
org.freehep.application.studio.Studio	getApplication()
Path	getHomeDirectory() Returns the path to the graphical console home directory.
org.freehep.util.FreeHEPLookup	getLookup() Returns a lookup instance that can be used objects registered by various components of the graphical console.
Object	getProperty(String key) Returns the value of the property with the specified key.
Window	getWindow() Returns the root component for the main Graphical Console window.
Map<String,ComponentDescriptor>	readDescriptors(Path path) Reads component descriptors from the specified XML file.
Object	removeProperty(String key) Removes a console property.
boolean	removePropertyListener(Console.PropertyListener listener) Removes the specified property listener.
void	restore()
void	restoreFrom()
void	save()
void	saveAs()
void	setProperties(Map<String,Object> properties) Sets values of a set of properties.
Object	setProperty(String key, Object value) Sets the value of the specified property.
void	showInBrowser(String url) Display the specified web site in a browser.
void	start()

Methods inherited from class org.lsst.ccs.gconsole.Console

getLogger

Methods inherited from class org.lsst.ccs.Subsystem

abort, abort, addClearAlertHandler, checkAllHardwareStarted, checkAllHardwareStopped, checkHardware, clearAlerts, clearAllAlerts, completeInitialization, completeInitialization, doShutdown, doStart, forceShutdown, getNumberCommandThreads, getRaisedAlertSummary, internalShutdown, internalStart, ping, postStart, printRunningCommands, raiseAlert, raiseAlert, removeLogPanicState, setBusLogHandlerLevel, setLogFormat, setLogHandlerLevel, setLogLevel, setStackTraceDepth, stop, switchToEngineeringMode, switchToNormalMode

Methods inherited from class org.lsst.ccs.Agent

addCommandSet, addCommandsFromObject, broadcastStatus, executeCommandRequest, getAgentInfo, getCCSVersions, getCommandCount, getCommandSet, getCommandTargets, getCurrentAction, getDictionaries, getDistributionInfo, getEnvironmentMessagingAccess, getMessagingAccess, getName, getScheduler, getState, getState, getStatusBroadcastPeriod, isInEngineeringMode, isInState, isInState, publishStateChange, publishSubsystemDataOnStatusBus, sendAck, sendNack, setAgentProperty, shutdown, updateAgentState, updateHeartBeat, updateInternalState, waitFor

Methods inherited from class java.lang.Object

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

Constructor Detail

Jas3Console

public Jas3Console()

Method Detail

start

public void start()

Overrides:

start in class org.lsst.ccs.Agent

getLookup

public org.freehep.util.FreeHEPLookup getLookup()

Description copied from class: Console

Returns a lookup instance that can be used objects registered by various components of the graphical console.

Specified by:

getLookup in class Console

Returns:

Lookup instance.

getWindow

public Window getWindow()

Description copied from class: Console

Returns the root component for the main Graphical Console window.

Specified by:

getWindow in class Console

Returns:

root component for the main Graphical Console window, or null if the root component is not a Window.

getApplication

public final org.freehep.application.studio.Studio getApplication()

getHomeDirectory

public Path getHomeDirectory()

Description copied from class: Console

Returns the path to the graphical console home directory. User preferences, console extensions, and miscellaneous auxiliary files saved by the graphical console are kept in this directory and its subdirectories.

Specified by:

getHomeDirectory in class Console

Returns:

The path to the graphical console home directory.

error

public void error(String message)

Description copied from class: Console

Notifies the user of an application error.

Specified by:

error in class Console

Parameters:

message - Message to be displayed.

error

public void error(String message,
                  Exception x)

Description copied from class: Console

Notifies the user of an application error.

Specified by:

error in class Console

Parameters:

message - Message to be displayed.

x - Exception to be reported.

showInBrowser

public void showInBrowser(String url)

Description copied from class: Console

Display the specified web site in a browser.

Specified by:

showInBrowser in class Console

Parameters:

url - URL of the site to be displayed.

addProperty

public void addProperty(String key,
                        Object defaultValue)

Description copied from class: Console

Defines a console property with the specified default value. Console properties can be later modified by calls to the Console.setProperty(String, Object) method or through the preference dialog if their keys are used in setter format strings passed to the Console.addPreference(String[], String, String) method. Properties that have been modified from their default values are saved between the graphical console sessions.

When a property is retrieved with a call to Console.getProperty(String) method, the type of the returned object is determined by the type of the default value supplied when the property was defined.

Specified by:

addProperty in class Console

Parameters:

key - Property key. Can be used to retrieve the property value.

defaultValue - Default value for the property. Must be of type Boolean, Enum, Integer, Long, Double, String, or an array containing objects of these types.

removeProperty

public Object removeProperty(String key)

Description copied from class: Console

Removes a console property. If the specified property has been previously defined through a call to Console.addProperty(String, Object) method, the property is removed and its current value is removed from storage; calling this method for a property that has not been defined has no effect.

Specified by:

removeProperty in class Console

Parameters:

key - Property key.

Returns:

Current value of the property, or null if there was no such property.

addPreference

public void addPreference(String[] path,
                          String group,
                          String format)

Description copied from class: Console

Adds a setter for one or more previously defined properties to the preferences menu. The format string contains one or more property references in the ${key#qualifiers} form. Qualifiers are separated by "#". At the moment, the only supported qualifier is "history=N".

Specified by:

addPreference in class Console

Parameters:

path - Path in the preferences tree to the page where the property setter should be displayed.

group - Group inside the preferences page. If null, the property setter is displayed in the default group.

format - Specifies the format of the property setter.

getProperty

public Object getProperty(String key)

Description copied from class: Console

Returns the value of the property with the specified key. The type of the returned object is determined by the type of the default value supplied when the property was defined. If the property with the specified key has never been defined through a call to Console.addProperty(String, Object) but exists in the console storage, it will be returned as a String.

Specified by:

getProperty in class Console

Parameters:

key - Property key.

Returns:

Value of the specified property, or null if the property does not exist.

setProperty

public Object setProperty(String key,
                          Object value)

Description copied from class: Console

Sets the value of the specified property. If the property with the specified key has never been defined through a call to Console.addProperty(String, Object) method, the value will be converted to a String and stored. Such keys cannot be used in setter format strings passed to Console.addPreference(String[], String, String) method.

If the property value is set to null, it is removed from storage, so subsequent calls to Console.getProperty(String) will return the default value, if it has been set.

Specified by:

setProperty in class Console

Parameters:

key - Property key.

value - Property value, or null if the property is being reset to its default value.

Returns:

The previous value of the specified property, or null if the property did not exist.

setProperties

public void setProperties(Map<String,Object> properties)

Description copied from class: Console

Sets values of a set of properties. See Console.setProperty(String, Object) for details on setting properties.

Overrides:

setProperties in class Console

addPropertyListener

public void addPropertyListener(Console.PropertyListener listener,
                                String filter)

Description copied from class: Console

Registers a listener that will be notified of property changes.

Specified by:

addPropertyListener in class Console

Parameters:

listener - The listener to be notified.

filter - Regular expression the property key has to match to trigger notification.

removePropertyListener

public boolean removePropertyListener(Console.PropertyListener listener)

Description copied from class: Console

Removes the specified property listener.

Specified by:

removePropertyListener in class Console

Parameters:

listener - Listener to be removed.

Returns:

True if the specified listener was registered with this console.

addMenu

public void addMenu(Action action,
                    String owner,
                    String... locations)

Description copied from class: Console

Adds an item to the graphical console menu bar.

The location strings specify a hierarchy of menus above the added item. Each string should be in the name[[:group]:position] format, where name is the text label of the menu the item should be added to, group is the ordinal number of the item group inside the menu, and position is the position inside the group. The first location string can also be prefixed with the desired location on the menu bar: [barPosition:]name[[:group]:position]. The menu is divided into groups by separators. If the group number is negative, items added with the same group number but different owners are put into the same group. If the group is not specified or is equal to 0, the item is added to the default group. The default group is shared by all owners.

Specified by:

addMenu in class Console

Parameters:

action - Action for the menu item to be added.

owner - Owner of the added menu item.

locations - Strings that specifies locations of the added item at all levels in the menu hierarchy.

restore

public void restore()

restoreFrom

public void restoreFrom()

save

public void save()

saveAs

public void saveAs()

readDescriptors

public Map<String,ComponentDescriptor> readDescriptors(Path path)

Reads component descriptors from the specified XML file.

Parameters:

path - Path to the file that contains descriptors; if null, getDefaultPath() is called to obtain the path.

Returns:

Component descriptors mapped by their names.