org.openbp.guiclient.plugins.displayobject
Class DisplayObjectPlugin

java.lang.Object
  org.openbp.jaspira.plugin.AbstractPlugin
      org.openbp.guiclient.plugins.displayobject.DisplayObjectPlugin

All Implemented Interfaces:

Plugin

public final class DisplayObjectPlugin
extends AbstractPlugin

The role option manager keeps track of various settings that depend on the role of the current user. This class is a plugin, but is also accessible as a singleton.

Author:

Heiko Erhardt

Nested Class Summary

class	DisplayObjectPlugin.Events Event module.
class	DisplayObjectPlugin.RoleOptionModule Global Cockpit options.

Nested classes/interfaces inherited from class org.openbp.jaspira.plugin.AbstractPlugin

AbstractPlugin.StandardPluginEvents

Field Summary

static java.lang.String	AUTODISPLAYNAME_OPTION Auto display name option
static int	TITLE_NAME Display object name as title
static int	TITLE_TEXT Display object display text as title
protected int	titleMode Object title display mode.

Fields inherited from class org.openbp.jaspira.plugin.AbstractPlugin

PROPERTY_CONDITION, PROPERTY_DESCRIPTION, PROPERTY_ICON, PROPERTY_NAME, PROPERTY_SEQUENCE, PROPERTY_TITLE, PROPERTY_VENDOR, PROPERTY_VERSION

Fields inherited from interface org.openbp.jaspira.plugin.Plugin

ID_DELIMETER, LEVEL_APPLICATION, LEVEL_FRAME, LEVEL_PAGE, LEVEL_PLUGIN

Constructor Summary

DisplayObjectPlugin()

Method Summary

static DisplayObjectPlugin	getInstance() Gets the singleton instance of this class.
java.lang.String	getResourceCollectionContainerName() Gets the name of the resource component the default resource of the plugin belongs to.
int	getTitleMode() Gets the object title display mode.
boolean	isTitleModeText() Determines if the object title display mode is set to 'text'.
protected void	readTitleModeOption() Reads the current value of the title mode from the option manager.
void	saveTitleModeOption() Saves the current value of the title mode to the option manager.
void	setTitleMode(int titleMode) Sets the object title display mode.

Methods inherited from class org.openbp.jaspira.plugin.AbstractPlugin

addActionKeySequence, addPlugin, addToPeerGroup, canClose, closeCanceled, containsStackedEvent, fireEvent, fireEvent, fireEvent, getAction, getChildPlugins, getClassName, getCondition, getDescendantPlugins, getDescription, getEventActionNames, getEventModules, getExternalActions, getExternalEventModuleClasses, getExternalOptionModuleClasses, getIcon, getIcon, getLevel, getName, getOptionModules, getParentPlugin, getPeerGroup, getPeerGroupNames, getPeerGroups, getPluginResourceCollection, getPluginState, getSubClients, getSubTitle, getTitle, getUniqueId, getVendor, getVersion, handleEvent, handleKeySequence, inheritEvent, initializeFromPluginProfile, initializePlugin, initializeResources, installFirstPlugin, installPlugin, installPluginContent, matchesPeerGroup, matchesPeerGroups, passDown, pluginInstalled, pluginUninstalled, preClose, receiveEvent, removeFromPeerGroup, removePlugin, removeStackedEvent, requestClose, setDescription, setIcon, setName, setParentPlugin, setPluginState, setResourceCollection, setTitle, stackEvent, toString, uninstallLastPlugin, uninstallPlugin

Methods inherited from class java.lang.Object

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

Field Detail

titleMode

protected int titleMode

Object title display mode. This option corresponds to the option "roleoption.titlemode".

TITLE_NAME

public static final int TITLE_NAME

Display object name as title

See Also:

Constant Field Values

TITLE_TEXT

public static final int TITLE_TEXT

Display object display text as title

See Also:

Constant Field Values

AUTODISPLAYNAME_OPTION

public static final java.lang.String AUTODISPLAYNAME_OPTION

Auto display name option

See Also:

Constant Field Values

Constructor Detail

DisplayObjectPlugin

public DisplayObjectPlugin()

Method Detail

getResourceCollectionContainerName

public java.lang.String getResourceCollectionContainerName()

Description copied from class: AbstractPlugin

Gets the name of the resource component the default resource of the plugin belongs to.

Specified by:

getResourceCollectionContainerName in class AbstractPlugin

Returns:

The container name

getInstance

public static DisplayObjectPlugin getInstance()

Gets the singleton instance of this class.

isTitleModeText

public boolean isTitleModeText()

Determines if the object title display mode is set to 'text'.

Returns:

true Display the object display text.
false Display the object name.

getTitleMode

public int getTitleMode()

Gets the object title display mode.

Returns:

TITLE_NAME/TITLE_TEXT

setTitleMode

public void setTitleMode(int titleMode)

Sets the object title display mode.

Parameters:

titleMode - TITLE_NAME/TITLE_TEXT

readTitleModeOption

protected void readTitleModeOption()

Reads the current value of the title mode from the option manager.

saveTitleModeOption

public void saveTitleModeOption()

Saves the current value of the title mode to the option manager. Also issues the displayobject.changed.titlemode event