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

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.GUICommandComponent
                          rs.sol.soloist.server.guiconfiguration.components.GUIMenuItemComponent

All Implemented Interfaces:

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

public class GUIMenuItemComponent
extends GUICommandComponent

A single entry in a menu. This widget can a) trigger client-side behavior (by binding its click (GUICommandComponent.opClick() method) output pin to other widget's input pin(s)), b) open a cascading sub-menu, or c) trigger server-side action specified with a Command object assigned to it.

If used in conjunction with a command, the assigned Command instance will be executed after user clicks on this widget, or after an event on other widget's output pin explicitely bound (using the widget binding mechanism) to this widget's click input pin ( ipClick() method).

Class PerformImmediately defines more complex execution scenarios. Applying specific execution scenario can be done with GUICommandComponent.setPerformImmediately(PerformImmediately) method.

Using the widget binding mechanism, this widget is able collect required parameters for command execution, and also, using the same mecahnism, to provide command execution results to other widgets in the GUI.

This widget can also act as a simple separator in the containing menu (setSeparator(boolean) method).

Author:

SOL Expert Group

Nested Class Summary

static class	GUIMenuItemComponent.FQPropertyNames Deprecated. Not for public use.
static class	GUIMenuItemComponent.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
IAssociationEndInstance<GUIMenuComponent>	ownerMenu Deprecated. Not for public use.
IAttributeValue<Boolean>	separator Deprecated. Not for public use.
IAssociationEndInstance<GUIMenuComponent>	subMenu Deprecated. Not for public use.

Fields inherited from class rs.sol.soloist.server.guiconfiguration.components.GUICommandComponent

click, command, commandExecuted, confirmationMessage, confirmationRequired, firstParam, performImmediately, redo, result, secondParam, text

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

GUIMenuItemComponent()

Method Summary

void	constructor() The domain-specific constructor of the Classifier.
static GUIMenuItemComponent	create(GUIMenuComponent menu) Deprecated. Not for public use.
static GUIMenuItemComponent	create(GUIMenuComponent menu, rs.sol.soloist.server.builtindomains.commands.Command cmd) Deprecated. Not for public use.
static GUIMenuItemComponent	create(GUIMenuComponent menu, java.lang.String text) Returns new GUIMenuItemComponent with the given text (label) and assigns it to the given parent menu.
static GUIMenuItemComponent	create(GUIMenuComponent menu, java.lang.String text, rs.sol.soloist.server.builtindomains.commands.Command cmd) Returns new GUIMenuItemComponent with the given text (label) and with the given command instance, and assigns it to the given parent menu.
static GUIMenuItemComponent	createSeparator(GUIMenuComponent menu) Returns new GUIMenuItemComponent that will act as a separator in the parent menu, and assigns it to the given parent menu.
rs.sol.soloist.client.common.info.MenuItemInfo	createSpecificInfo() Creates and returns an empty serializable object of the appropriate ComponentInfo sub-class.
GUIApplicationComponent	getApplication() Returns the owner GUIApplicationComponent of this widget.
GUIMenuComponent	getOwnerMenu() Deprecated. Not for public use.
boolean	getSeparator() Returns whether this item is separator or not.
GUIMenuComponent	getSubMenu() Returns owned menu (GUIMenuComponent) if it exists.
boolean	isSeparator() Deprecated. Not for public use.
void	setSeparator(boolean separator) Sets whether this item is separator or not.
void	setSubMenu(GUIMenuComponent menu) Sets GUIMenuComponent that will act as a sub-menu of this menu item.

Methods inherited from class rs.sol.soloist.server.guiconfiguration.components.GUICommandComponent

create, create, execute, getCommand, getConfirmationMessage, getConfirmationRequired, getPerformImmediately, getText, getTextOrCommandName, ipClick, ipFirstParam, ipRedo, ipSecondParam, ipText, isConfirmationRequired, opClick, opCommandExecuted, opResult, setCommand, setConfirmationMessage, setConfirmationRequired, setPerformImmediately, setText

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

addStyleNames, addValueToSlot, clearSlot, clone, createInfo, createInfoAlreadyValidated, destructor, fillElementInfo, 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

separator

@Deprecated
public IAttributeValue<Boolean> separator

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

ownerMenu

@Deprecated
public IAssociationEndInstance<GUIMenuComponent> ownerMenu

Deprecated. Not for public use.

subMenu

@Deprecated
public IAssociationEndInstance<GUIMenuComponent> subMenu

Deprecated. Not for public use.

Constructor Detail

GUIMenuItemComponent

public GUIMenuItemComponent()

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 GUICommandComponent

createSpecificInfo

public rs.sol.soloist.client.common.info.MenuItemInfo createSpecificInfo()

Description copied from class: GUIComponent

Creates and returns an empty serializable object of the appropriate ComponentInfo sub-class. The returned object must be able to transmit every property of objects of this class from server to clients (browsers).

Returns:

a ComponentInfo sub-class instance

create

public static GUIMenuItemComponent create(GUIMenuComponent menu,
                                          java.lang.String text)

Returns new GUIMenuItemComponent with the given text (label) and assigns it to the given parent menu.

Parameters:

menu - the parent GUIMenuComponent widget

text - the item's text or label

Returns:

new GUIMenuItemComponent

create

public static GUIMenuItemComponent create(GUIMenuComponent menu,
                                          java.lang.String text,
                                          rs.sol.soloist.server.builtindomains.commands.Command cmd)

Returns new GUIMenuItemComponent with the given text (label) and with the given command instance, and assigns it to the given parent menu.

Parameters:

menu - the parent GUIMenuComponent widget

text - the item's text or label

cmd - the command instance for handling server side action

Returns:

new GUIMenuItemComponent

createSeparator

public static GUIMenuItemComponent createSeparator(GUIMenuComponent menu)

Returns new GUIMenuItemComponent that will act as a separator in the parent menu, and assigns it to the given parent menu.

Parameters:

menu - the parent GUIMenuComponent widget

Returns:

new GUIMenuItemComponent

getApplication

public GUIApplicationComponent getApplication()

Description copied from class: GUIComponent

Returns the owner GUIApplicationComponent of this widget.

Overrides:

getApplication in class GUIComponent

Returns:

the GUIApplicationComponent that owns this widget in its sub-tree. Returns null if this widget is not added to a GUI tree.

getSeparator

public boolean getSeparator()

Returns whether this item is separator or not.

Returns:

whether this item is separator or not

See Also:

setSeparator(boolean)

setSeparator

public void setSeparator(boolean separator)

Sets whether this item is separator or not.

Parameters:

separator - a boolean that tells whether this item is separator or not

getSubMenu

public GUIMenuComponent getSubMenu()

Returns owned menu (GUIMenuComponent) if it exists.

Returns:

owned menu (GUIMenuComponent) if it exists

See Also:

setSubMenu(GUIMenuComponent)

setSubMenu

public void setSubMenu(GUIMenuComponent menu)

Sets GUIMenuComponent that will act as a sub-menu of this menu item.

Parameters:

menu - GUIMenuComponent that will act as a sub-menu of this menu item

getOwnerMenu

@Deprecated
public GUIMenuComponent getOwnerMenu()

Deprecated. Not for public use.

isSeparator

@Deprecated
public boolean isSeparator()

Deprecated. Not for public use.

create

@Deprecated
public static GUIMenuItemComponent create(GUIMenuComponent menu,
                                                     rs.sol.soloist.server.builtindomains.commands.Command cmd)

Deprecated. Not for public use.

create

@Deprecated
public static GUIMenuItemComponent create(GUIMenuComponent menu)

Deprecated. Not for public use.