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

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.GUIMenuComponent

All Implemented Interfaces:

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

public class GUIMenuComponent
extends GUIComponent

A regular menu widget with an arbitrary number of menu items. Menu items (class GUIMenuItemComponent) are rendered in a vertical or in a horizontal layout (setHorizontal(boolean) method).

Author:

SOL Expert Group

Nested Class Summary

static class	GUIMenuComponent.FQPropertyNames Deprecated. Not for public use.
static class	GUIMenuComponent.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<Boolean>	horizontal Deprecated. Not for public use.
IAssociationEndInstance<GUIMenuItemComponent>	items Deprecated. Not for public use.
IAssociationEndInstance<GUIMenuItemComponent>	ownerItem 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

GUIMenuComponent()

Method Summary

static GUIMenuItemComponent	addItem(GUIMenuComponent menu, java.lang.String text) Deprecated. Not for public use.
static GUIMenuItemComponent	addItem(GUIMenuComponent menu, java.lang.String text, GUIComponent whatToShow) Deprecated. Not for public use.
static GUIMenuItemComponent	addItem(GUIMenuComponent menu, java.lang.String name, java.lang.String text) Deprecated. Not for public use.
void	addItem(GUIMenuItemComponent c) Adds one menu item in the collection of menu items.
static GUIMenuItemComponent	addSeparator(GUIMenuComponent menu) Deprecated. Not for public use.
void	clearItems() Clears all owned menu items.
void	constructor() The domain-specific constructor of the Classifier.
static GUIMenuComponent	create(GUIMenuItemComponent item, boolean horizontal) Deprecated. Not for public use.
static GUIMenuComponent	create(GUIPanelComponent parent, boolean horizontal) Returns new horizontal or vertical GUIMenuComponent and assigns it to the given parent.
rs.sol.soloist.client.common.info.MenuInfo	createSpecificInfo() Creates and returns an empty serializable object of the appropriate ComponentInfo sub-class.
static GUIMenuComponent	createSubMenu(GUIMenuItemComponent item, boolean horizontal) Returns new horizontal or vertical GUIMenuComponent and assigns it to the given owner menu item.
GUIApplicationComponent	getApplication() Returns the owner GUIApplicationComponent of this widget.
boolean	getHorizontal() Returns the direction (horizontal or vertical) of this menu.
java.util.List<GUIMenuItemComponent>	getItems() Returns the collection of menu items.
GUIMenuItemComponent	getOwnerItem() Deprecated. Not for public use.
boolean	isHorizontal() Deprecated. Not for public use.
void	removeItem(GUIMenuItemComponent c) Removes one menu item from the collection of menu items.
void	setHorizontal(boolean horizontal) Sets the direction (horizontal or vertical) of this menu.
void	setItems(java.util.List<GUIMenuItemComponent> menuItems) Sets the collection of menu items.

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

horizontal

@Deprecated
public IAttributeValue<Boolean> horizontal

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

items

@Deprecated
public IAssociationEndInstance<GUIMenuItemComponent> items

Deprecated. Not for public use.

ownerItem

@Deprecated
public IAssociationEndInstance<GUIMenuItemComponent> ownerItem

Deprecated. Not for public use.

Constructor Detail

GUIMenuComponent

public GUIMenuComponent()

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

createSpecificInfo

public rs.sol.soloist.client.common.info.MenuInfo 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 GUIMenuComponent create(GUIPanelComponent parent,
                                      boolean horizontal)

Returns new horizontal or vertical GUIMenuComponent and assigns it to the given parent.

Parameters:

parent - the parent GUIPanelComponent widget

horizontal - a boolean that tells the menu's direction

Returns:

new GUIMenuComponent

createSubMenu

public static GUIMenuComponent createSubMenu(GUIMenuItemComponent item,
                                             boolean horizontal)

Returns new horizontal or vertical GUIMenuComponent and assigns it to the given owner menu item.

Parameters:

item - the owner GUIMenuItemComponent widget

horizontal - a boolean that tells the menu's direction

Returns:

new GUIMenuComponent

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.

getHorizontal

public boolean getHorizontal()

Returns the direction (horizontal or vertical) of this menu.

Returns:

the direction (horizontal or vertical) of this menu

See Also:

setHorizontal(boolean)

setHorizontal

public void setHorizontal(boolean horizontal)

Sets the direction (horizontal or vertical) of this menu.

Parameters:

horizontal - the direction (horizontal or vertical) of this menu

getItems

public java.util.List<GUIMenuItemComponent> getItems()

Returns the collection of menu items.

Returns:

the collection of menu items

setItems

public void setItems(java.util.List<GUIMenuItemComponent> menuItems)

Sets the collection of menu items.

Parameters:

menuItems - the collection of menu items

addItem

public void addItem(GUIMenuItemComponent c)

Adds one menu item in the collection of menu items.

Parameters:

c - the menu item to be added

removeItem

public void removeItem(GUIMenuItemComponent c)

Removes one menu item from the collection of menu items.

Parameters:

c - the menu item to be removed

clearItems

public void clearItems()

Clears all owned menu items.

create

@Deprecated
public static GUIMenuComponent create(GUIMenuItemComponent item,
                                                 boolean horizontal)

Deprecated. Not for public use.

addItem

@Deprecated
public static GUIMenuItemComponent addItem(GUIMenuComponent menu,
                                                      java.lang.String name,
                                                      java.lang.String text)

Deprecated. Not for public use.

addItem

@Deprecated
public static GUIMenuItemComponent addItem(GUIMenuComponent menu,
                                                      java.lang.String text)

Deprecated. Not for public use.

addSeparator

@Deprecated
public static GUIMenuItemComponent addSeparator(GUIMenuComponent menu)

Deprecated. Not for public use.

addItem

@Deprecated
public static GUIMenuItemComponent addItem(GUIMenuComponent menu,
                                                      java.lang.String text,
                                                      GUIComponent whatToShow)

Deprecated. Not for public use.

getOwnerItem

@Deprecated
public GUIMenuItemComponent getOwnerItem()

Deprecated. Not for public use.

isHorizontal

@Deprecated
public boolean isHorizontal()

Deprecated. Not for public use.