rs.sol.soloist.server.guiconfiguration.construction
Class GUIComponent

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

All Implemented Interfaces:

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

Direct Known Subclasses:

GUICommandComponent, GUIContainerComponent, GUIElementComponent, GUIHTMLComponent, GUIImageComponent, GUILabelComponent, GUILinkComponent, GUIMenuComponent, GUINonVisualComponent, GUISearchResultComponent, GUISingleElementComponent, GUIStatusBarComponent, GUITimerComponent

public abstract class GUIComponent
extends rs.sol.soloist.server.builtindomains.common.ObjectOfClass
implements IUpdatable, IElementPresentationProvider

An abstract base class for all kinds of GUI widgets: labels, buttons, menus, links, panels, dialogs, images, non-visual components...

Widgets interact between each other via the widget binding mechanism. Each widget has its own set of input and output pins. Output pins are actually a substitution for events and could be fetched using methods with op name prefix. Input pins correspond to actions that should be invoked after event occurs and could be fetched using methods with ip name prefix. Widget interaction is specfied by connecting output pin (event) of one widget with input pin (action) of the other. Class GUIComponentBinding is responsible for connecting widget pins. Widget binding mechanism is a replacement for the classical mechanism of event-handlers.

Widgets can be organized in a different kinds of layout configurations. Classes Layout and LayoutData contain more information about layout.

If this widget presents domain information, like for example lists, trees, tables, text boxes, etc., it should have its data formatting defined via GUIContext. The assingnment of GUIContext can be done by calling setContext(GUIContext) method.

Each (visible) widget can be initially visually styled in terms of CSS using the setStyle(String) method. In the run-time however, style modifications can be defined using this widgte's addStyle (ipAddStyle() method) and removeStyle (ipRemoveStyle() method) input pins.

Author:

SOL Expert Group

See Also:

GUIPanelComponent

Nested Class Summary

static class	GUIComponent.FQPropertyNames Deprecated. Not for public use.
static class	GUIComponent.PROPERTIES Deprecated. Not for public use.

Field Summary

IAttributeValue<Text>	addStyle Deprecated. Not for public use.
static IClass	CLASSIFIER UML class reference
IAssociationEndInstance<GUIContext>	context Deprecated. Not for public use.
IAttributeValue<Text>	description Deprecated. Not for public use.
IAttributeValue<Boolean>	enabled Deprecated. Not for public use.
static java.lang.String	FQ_TYPE_NAME Fully qualified UML class name
IAttributeValue<Text>	init Deprecated. Not for public use.
IAssociationEndInstance<GUIComponentBinding>	inputBindings Deprecated. Not for public use.
IAssociationEndInstance<LayoutData>	layoutData Deprecated. Not for public use.
static org.apache.log4j.Logger	logger Deprecated. Not for public use in the future.
IAttributeValue<Text>	name Deprecated. Not for public use.
IAssociationEndInstance<GUIComponentBinding>	outputBindings Deprecated. Not for public use.
IAssociationEndInstance<GUITableWidget>	ownerTable Deprecated. Not for public use.
IAssociationEndInstance<GUIContainerComponent>	parent Deprecated. Not for public use. Use methods like add, remove, clear, set, etc that manage container's children in the GUIContainerComponent.
IAttributeValue<Text>	removeStyle Deprecated. Not for public use.
IAttributeValue<Text>	show Deprecated. Not for public use.
IAttributeValue<Text>	showInParent Deprecated. Not for public use.
IAttributeValue<Text>	styleName Deprecated. Not for public use.
IAttributeValue<Text>	tooltip Deprecated. Not for public use.
IAttributeValue<Boolean>	visible Deprecated. Not for public use.

Constructor Summary

GUIComponent()

Method Summary

void	addStyleNames(java.lang.String... styleNames) Concatenates style names and adds them to existing ones.
rs.sol.soloist.client.common.requests.HasNotificationsResult	addValueToSlot(rs.sol.soloist.client.common.descr.Descr slotDescr, java.io.Serializable value) Deprecated. Not for public use.
rs.sol.soloist.client.common.requests.HasNotificationsResult	clearSlot(rs.sol.soloist.client.common.descr.Descr slotDescr) Deprecated. Not for public use.
GUIComponent	clone() Deprecated. Not for public use.
void	constructor() The domain-specific constructor of the Classifier.
rs.sol.soloist.client.common.info.ComponentInfo	createInfo() Deprecated. Not for public use.
rs.sol.soloist.client.common.info.ComponentInfo	createInfoAlreadyValidated() Deprecated. Not for public use.
void	destructor() Deprecated. Not for public use.
void	fillElementInfo(rs.sol.soloist.server.uml.concepts.IElement el, rs.sol.soloist.client.common.info.element.ElementInfo info) Deprecated. Not for public use.
GUIApplicationComponent	getApplication() Returns the owner GUIApplicationComponent of this widget.
java.util.List<rs.sol.soloist.server.builtindomains.commands.Command>	getCommands(rs.sol.soloist.server.uml.concepts.IElement el) Deprecated. Not for public use.
java.util.List<rs.sol.soloist.server.builtindomains.commands.Command>	getCommands(rs.sol.soloist.server.uml.concepts.IElement el, rs.sol.soloist.server.uml.concepts.IElement source) Deprecated. Not for public use.
static GUIComponent	getCommonOwner(GUIComponent c1, GUIComponent c2) Returns the first common widget that is the direct or indirect owner (parent) of the two given widgetss.
GUIContext	getContext() Returns the GUI Context in which this widget is placed.
java.lang.String	getDescription() Returns the description of this widget.
Text	getDescrString(rs.sol.soloist.server.uml.concepts.IElement el) Deprecated. Not for public use.
Picture	getDragIcon(rs.sol.soloist.server.uml.concepts.IElement el) Deprecated. Not for public use.
boolean	getEnabled() Tells whether this widget is enabled or disabled.
GUISettingFeature	getFeature(rs.sol.soloist.server.uml.concepts.IElement el, java.lang.String name) Returns the GUISettingFeature with the given name in the GUIContext of this widget that describes the given element.
GUISettingFeature	getFeature(java.lang.String name) Returns the GUISettingFeature with the given name in the GUIContext of this widget.
java.util.List<GUIComponentBinding>	getInputBindings(ISlot pin) Deprecated. Not for public use.
ISlot	getInputPin(java.lang.String name) Deprecated. Not for public use.
java.util.List<ISlot>	getInputPins() Deprecated. Not for public use.
Text	getLabelString(rs.sol.soloist.server.uml.concepts.IElement el) Deprecated. Not for public use.
Picture	getLargeIcon(rs.sol.soloist.server.uml.concepts.IElement el) Deprecated. Not for public use.
LayoutData	getLayoutData() Returns the LayoutData for this widget.
java.lang.String	getName() Returns the name of this widget.
Text	getNameString(rs.sol.soloist.server.uml.concepts.IElement el) Deprecated. Not for public use.
ISlot	getOutputPin(java.lang.String name) Deprecated. Not for public use.
java.util.List<ISlot>	getOutputPins() Deprecated. Not for public use.
GUIComponent	getOwner() Deprecated. Not for public use.
java.util.List<GUIComponent>	getParts() Deprecated. Not for public use.
GUIItemSetting	getSetting(rs.sol.soloist.server.uml.concepts.IElement el) Returns the GUIItemSetting in the GUIContext of this widget that describes the given element.
Picture	getSmallIcon(rs.sol.soloist.server.uml.concepts.IElement el) Deprecated. Not for public use.
java.lang.String	getStyle() Returns the CSS style of this widget.
java.util.List<rs.sol.soloist.server.uml.concepts.IElement>	getSubnodes(rs.sol.soloist.server.uml.concepts.IElement el) Deprecated. Not for public use.
java.lang.String	getTooltip() Returns the tooltip of this widget.
Text	getTooltipString(rs.sol.soloist.server.uml.concepts.IElement el) Deprecated. Not for public use.
Text	getTypeString(rs.sol.soloist.server.uml.concepts.IElement el) Deprecated. Not for public use.
boolean	getVisible() Tells whether this widget is visible or not.
java.lang.Object	handle(rs.sol.soloist.client.common.requests.Request request) Handles single request from the client (browser) and returns an appropriate response.
ISlot<?>	ipAddStyle() A getter of an input pin responsible for adding a CSS style to this widget.
ISlot<?>	ipEnabled() A getter of an input pin responsible for enabling or disabling this widget.
ISlot<?>	ipInit() A getter of an input pin responsible for (re)initialization of this widget.
ISlot<?>	ipRemoveStyle() A getter of an input pin responsible for removing a CSS style from this widget.
ISlot<?>	ipShow() A getter of an input pin responsible for making all the ancestors of this widget in the GUI tree show their sub-tree that contains this widget.
ISlot<?>	ipShowInParent() A getter of an input pin responsible for making the first ancestor of this widget in the GUI tree show its sub-tree rooted at this widget.
ISlot<?>	ipVisible() A getter of an input pin responsible for making this widget visible or invisible.
static boolean	isInputPin(ISlot slot) Deprecated. Not for public use.
static boolean	isOutputPin(ISlot slot) Deprecated. Not for public use.
void	putFeatureInfo(rs.sol.soloist.server.uml.concepts.IElement el, rs.sol.soloist.client.common.info.element.ElementInfo info, java.lang.String name) Deprecated. Not for public use.
rs.sol.soloist.client.common.info.element.ElementInfo	readElement(rs.sol.soloist.client.common.descr.Descr descr) Deprecated. Not for public use.
java.util.List<rs.sol.soloist.client.common.info.element.ElementInfo>	readElements(java.util.List<rs.sol.soloist.client.common.descr.Descr> descrs) Deprecated. Not for public use.
rs.sol.soloist.client.common.ValuesAsDescrResult	readSlot(rs.sol.soloist.client.common.descr.Descr slotDescr) Deprecated. Not for public use.
rs.sol.soloist.client.common.ValuesAsInfoResult	readSlotAsInfo(rs.sol.soloist.client.common.descr.Descr slotDescr) Deprecated. Not for public use.
rs.sol.soloist.client.common.info.element.SubnodesInfo	readSubnodes(rs.sol.soloist.client.common.descr.Descr descr) Deprecated. Not for public use.
rs.sol.soloist.client.common.requests.HasNotificationsResult	removeValueFromSlot(rs.sol.soloist.client.common.descr.Descr slotDescr, java.io.Serializable value) Deprecated. Not for public use.
void	setCellAlignment(HorizontalAlignment ha, VerticalAlignment va) Sets the horizontal and vertical alignment of this widget's container cell.
void	setCellSize(java.lang.String width, java.lang.String height) Sets the size of this widget's container cell.
void	setCellStyle(java.lang.String style) Sets the CSS style this widget's container cell.
void	setCenter() Places this widget in a central position in a dock layout.
void	setContext(GUIContext c) Sets the GUIContext to this widget.
void	setDescription(java.lang.String desc) Sets the description of this widget.
void	setDirectionAndSize(DockLayoutDirection direction, double size) Sets this widget position and size in a dock layout.
void	setEnabled(boolean enabled) Sets this widget to be enabled or disabled.
void	setLayoutData(LayoutData ld) Sets the LayoutData to this widget.
void	setLeftRightWidth(java.lang.String left, java.lang.String right, java.lang.String width) Sets this widget's horizontal constraints and width in a layer layout.
void	setName(java.lang.String name) Sets the name of this widget.
void	setRowColumn(int row, int column) Sets the row and column indices for this widget.
void	setRowColumn(int row, int column, int rowSpan, int colSpan) Sets the row and column indices for this widget.
void	setSize(java.lang.String width, java.lang.String height) Sets the size of this widget.
rs.sol.soloist.client.common.requests.HasNotificationsResult	setSlot(rs.sol.soloist.client.common.descr.Descr slotDescr, java.util.List<java.io.Serializable> values) Deprecated. Not for public use.
rs.sol.soloist.client.common.requests.HasNotificationsResult	setSlot(rs.sol.soloist.client.common.descr.Descr slotDescr, java.io.Serializable value) Deprecated. Not for public use.
void	setStyle(java.lang.String style) Sets the CSS style of this widget.
void	setTooltip(java.lang.String tooltip) Sets the tooltip of this widget.
void	setTopBottomHeight(java.lang.String top, java.lang.String bottom, java.lang.String height) Sets this widget's vertical constraints and height in a layer layout.
void	setVisible(boolean visible) Sets the visibility of this widget.
void	setXY(int x, int y) Sets the x and y coordinates of this widget.
boolean	toTranslateDescriptors() Deprecated. Not for public use.
static java.lang.String	translatePinName(ISlot pin) Deprecated. Not for public use.
void	updateInfo(java.lang.Object info) Deprecated. Not for public use.
void	validate() Validates a configuration settings of this widget.
java.util.Map<GUIComponent,IllegalComponentStateException>	validateParts() Deprecated. Not for public use.
void	validateParts(java.lang.Iterable<GUIComponent> components, java.util.Map<GUIComponent,IllegalComponentStateException> exceptions) Deprecated. Not for public use.

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

name

@Deprecated
public final IAttributeValue<Text> name

Deprecated. Not for public use.

A placeholder for the information to be used to create a specific kind or subkind of Component Instance of the same Component.

description

@Deprecated
public final IAttributeValue<Text> description

Deprecated. Not for public use.

A placeholder for the information to be used to create a specific kind or subkind of Component Instance of the same Component.

styleName

@Deprecated
public final IAttributeValue<Text> styleName

Deprecated. Not for public use.

tooltip

@Deprecated
public final IAttributeValue<Text> tooltip

Deprecated. Not for public use.

enabled

@Deprecated
public final IAttributeValue<Boolean> enabled

Deprecated. Not for public use.

visible

@Deprecated
public final IAttributeValue<Boolean> visible

Deprecated. Not for public use.

show

@Deprecated
public final IAttributeValue<Text> show

Deprecated. Not for public use.

showInParent

@Deprecated
public final IAttributeValue<Text> showInParent

Deprecated. Not for public use.

init

@Deprecated
public final IAttributeValue<Text> init

Deprecated. Not for public use.

addStyle

@Deprecated
public final IAttributeValue<Text> addStyle

Deprecated. Not for public use.

removeStyle

@Deprecated
public final IAttributeValue<Text> removeStyle

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

outputBindings

@Deprecated
public final IAssociationEndInstance<GUIComponentBinding> outputBindings

Deprecated. Not for public use.

context

@Deprecated
public final IAssociationEndInstance<GUIContext> context

Deprecated. Not for public use.

inputBindings

@Deprecated
public final IAssociationEndInstance<GUIComponentBinding> inputBindings

Deprecated. Not for public use.

parent

@Deprecated
public final IAssociationEndInstance<GUIContainerComponent> parent

Deprecated. Not for public use. Use methods like add, remove, clear, set, etc that manage container's children in the GUIContainerComponent.

See Also:

GUIContainerComponent

layoutData

@Deprecated
public final IAssociationEndInstance<LayoutData> layoutData

Deprecated. Not for public use.

ownerTable

@Deprecated
public final IAssociationEndInstance<GUITableWidget> ownerTable

Deprecated. Not for public use.

logger

@Deprecated
public static final org.apache.log4j.Logger logger

Deprecated. Not for public use in the future.

Constructor Detail

GUIComponent

public GUIComponent()

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 rs.sol.soloist.server.builtindomains.common.ObjectOfClass

getCommonOwner

public static GUIComponent getCommonOwner(GUIComponent c1,
                                          GUIComponent c2)

Returns the first common widget that is the direct or indirect owner (parent) of the two given widgetss.

Parameters:

c1 - the GUIComponent whose owner (parent) should be retrived

c2 - the GUIComponent whose owner (parent) should be retrived

Returns:

the GUIComponent which is the first common owner (parent) of the two given widgets

clone

@Deprecated
public GUIComponent clone()

Deprecated. Not for public use.

Clones the Component. If it has subcomponents (parts), clones deeply the entire structure, including Component bindings.

Overrides:

clone in class java.lang.Object

getContext

public GUIContext getContext()

Returns the GUI Context in which this widget is placed. It is either its own (redefined) GUIContext, or the GUIContext inherited from the parent widget.

Returns:

an GUIContext owned or inherited from the parent widget

getSetting

public GUIItemSetting getSetting(rs.sol.soloist.server.uml.concepts.IElement el)

Returns the GUIItemSetting in the GUIContext of this widget that describes the given element.

Parameters:

el - an IElement (object, data type instance, or even a model element) for which the corresponding GUIItemSetting should be retrived

Returns:

the GUIItemSetting in the GUIContext of this widget that describes the given element. Returns null if such does not exist.

getFeature

public GUISettingFeature getFeature(rs.sol.soloist.server.uml.concepts.IElement el,
                                    java.lang.String name)

Returns the GUISettingFeature with the given name in the GUIContext of this widget that describes the given element.

Parameters:

el - an IElement (object, data type instance, or even a model element) for which the corresponding GUISettingFeature should be retrived.

name - the String with the name of the feature

Returns:

the GUISettingFeature in the GUIContext of this widget that describes the given element. Returns null if such does not exist.

getFeature

public GUISettingFeature getFeature(java.lang.String name)

Returns the GUISettingFeature with the given name in the GUIContext of this widget.

Parameters:

name - the String with the name of the feature

Returns:

the GUISettingFeature in the GUIContext of this widget. Returns null if such does not exist.

getNameString

@Deprecated
public Text getNameString(rs.sol.soloist.server.uml.concepts.IElement el)

Deprecated. Not for public use.

Returns a string that serves as a name of the given Element.

Returns null if such does not exist.

Returns ((GUITextFeature)getFeature(getElement(el),"Name")).getValue(getElement(el)).

getTypeString

@Deprecated
public Text getTypeString(rs.sol.soloist.server.uml.concepts.IElement el)

Deprecated. Not for public use.

Returns a string that serves as the type of the given Element.

Returns null if such does not exist.

Returns ((GUITextFeature)getFeature(getElement(el),"Type")).getValue(getElement(el)).

getDescrString

@Deprecated
public Text getDescrString(rs.sol.soloist.server.uml.concepts.IElement el)

Deprecated. Not for public use.

Returns a string that serves as the description of the given Element.

Returns null if such does not exist.

Returns ((GUITextFeature)getFeature(getElement(el),"Description")).getValue(getElement(el)).

getLabelString

@Deprecated
public Text getLabelString(rs.sol.soloist.server.uml.concepts.IElement el)

Deprecated. Not for public use.

Returns a string that serves as the label of the given Element.

Returns null if such does not exist.

Returns ((GUITextFeature)getFeature(getElement(el),"Label")).getValue(getElement(el)).

getTooltipString

@Deprecated
public Text getTooltipString(rs.sol.soloist.server.uml.concepts.IElement el)

Deprecated. Not for public use.

Returns a string that serves as the tooltip of the given Element.

Returns null if such does not exist.

Returns ((GUITextFeature)getFeature(getElement(el),"Tooltip")).getValue(getElement(el)).

getSmallIcon

@Deprecated
public Picture getSmallIcon(rs.sol.soloist.server.uml.concepts.IElement el)

Deprecated. Not for public use.

Returns a picture that serves as the small icon for the given Element.

Returns null if such does not exist.

Returns ((GUIPictureFeature)getFeature(getElement(el),"SmallIcon")).getValue(getElement(el)).

getLargeIcon

@Deprecated
public Picture getLargeIcon(rs.sol.soloist.server.uml.concepts.IElement el)

Deprecated. Not for public use.

Returns a picture that serves as the large icon for the given Element.

Returns null if such does not exist.

Returns ((GUIPictureFeature)getFeature(getElement(el),"LargeIcon")).getValue(getElement(el)).

getDragIcon

@Deprecated
public Picture getDragIcon(rs.sol.soloist.server.uml.concepts.IElement el)

Deprecated. Not for public use.

Returns a picture that serves as the drag and drop icon for the given Element.

Returns null if such does not exist.

Returns ((GUIPictureFeature)getFeature(getElement(el),"DragIcon")).getValue(getElement(el)).

getSubnodes

@Deprecated
public java.util.List<rs.sol.soloist.server.uml.concepts.IElement> getSubnodes(rs.sol.soloist.server.uml.concepts.IElement el)

Deprecated. Not for public use.

Returns a collection of Elements that are subnodes of the given Element.

Returns null if such does not exist.

Returns ((GUINavigatorFeature)getFeature(getElement(el),"Subnodes")).getElements(getElement(el)).

getCommands

@Deprecated
public java.util.List<rs.sol.soloist.server.builtindomains.commands.Command> getCommands(rs.sol.soloist.server.uml.concepts.IElement el)

Deprecated. Not for public use.

Returns a collection of Commands for the given Element.

Returns null if such does not exist.

Returns ((GUICommandsFeature)getFeature(getElement(el),"Commands")).getCommands(getElement(el)).

getCommands

@Deprecated
public java.util.List<rs.sol.soloist.server.builtindomains.commands.Command> getCommands(rs.sol.soloist.server.uml.concepts.IElement el,
                                                                                                    rs.sol.soloist.server.uml.concepts.IElement source)

Deprecated. Not for public use.

Returns a collection of Commands when the given source Element is "applied on" (e.g. dropped on) the given Element.

Returns null if such does not exist.

Returns ((GUIMultitypingFeature)getFeature(getElement(el),"DragAndDropCommands")).getCommands(source,getElement(el)).

isInputPin

@Deprecated
public static boolean isInputPin(ISlot slot)

Deprecated. Not for public use.

Returns true if the specified Slot is input or relay pin.

Input pins are Slots stereotyped with <> or <>.

Relay pins are Slots stereotyped with <>.

isOutputPin

@Deprecated
public static boolean isOutputPin(ISlot slot)

Deprecated. Not for public use.

Returns true if the specified Slot is output or relay pin.

Output pins are Slots stereotyped with <

> or <>.

Relay pins are Slots stereotyped with <>.

getInputPin

@Deprecated
public ISlot getInputPin(java.lang.String name)

Deprecated. Not for public use.

Returns the input or relay pin with the given qualified or unqualified name.

In case of unqualified name, the search by name for the input pin starts from the direct Classifier of this Component upwards the generalization hierarchy.

Returns null if such does not exist.

getOutputPin

@Deprecated
public ISlot getOutputPin(java.lang.String name)

Deprecated. Not for public use.

Returns the output or relay pin with the given qualified or unqualified name.

In case of unqualified name, the search by name for the input pin starts from the direct Classifier of this Component upwards the generalization hierarchy.

Returns null if such does not exist.

getInputPins

@Deprecated
public java.util.List<ISlot> getInputPins()

Deprecated. Not for public use.

getOutputPins

@Deprecated
public java.util.List<ISlot> getOutputPins()

Deprecated. Not for public use.

getOwner

@Deprecated
public GUIComponent getOwner()

Deprecated. Not for public use.

Returns the owner of this Component. This method requires that all association ends towards possible owners are navigable.

getParts

@Deprecated
public java.util.List<GUIComponent> getParts()

Deprecated. Not for public use.

validate

public void validate()

Validates a configuration settings of this widget.

Throws:

IllegalComponentStateException - If this widget is misconfigured.

destructor

@Deprecated
public void destructor()

Deprecated. Not for public use.

Destroys all input and output bindings as well.

Specified by:

destructor in interface IClassifierInstance

Overrides:

destructor in class rs.sol.soloist.server.uml.commonimplementation.runtime._ClassifierInstance

addStyleNames

public void addStyleNames(java.lang.String... styleNames)

Concatenates style names and adds them to existing ones. Will ignore parameters which are null or empty strings.

Parameters:

styleNames - String array of style names to be added to existing ones

getInputBindings

@Deprecated
public java.util.List<GUIComponentBinding> getInputBindings(ISlot pin)

Deprecated. Not for public use.

validateParts

@Deprecated
public void validateParts(java.lang.Iterable<GUIComponent> components,
                                     java.util.Map<GUIComponent,IllegalComponentStateException> exceptions)

Deprecated. Not for public use.

validateParts

@Deprecated
public final java.util.Map<GUIComponent,IllegalComponentStateException> validateParts()

Deprecated. Not for public use.

translatePinName

@Deprecated
public static java.lang.String translatePinName(ISlot pin)

Deprecated. Not for public use.

Translates pin to a name used on the client. Currently fully qualified names are used

createInfo

@Deprecated
public final rs.sol.soloist.client.common.info.ComponentInfo createInfo()

Deprecated. Not for public use.

createInfoAlreadyValidated

@Deprecated
public final rs.sol.soloist.client.common.info.ComponentInfo createInfoAlreadyValidated()

Deprecated. Not for public use.

putFeatureInfo

@Deprecated
public final void putFeatureInfo(rs.sol.soloist.server.uml.concepts.IElement el,
                                            rs.sol.soloist.client.common.info.element.ElementInfo info,
                                            java.lang.String name)

Deprecated. Not for public use.

fillElementInfo

@Deprecated
public void fillElementInfo(rs.sol.soloist.server.uml.concepts.IElement el,
                                       rs.sol.soloist.client.common.info.element.ElementInfo info)

Deprecated. Not for public use.

Specified by:

fillElementInfo in interface IElementPresentationProvider

toTranslateDescriptors

@Deprecated
public boolean toTranslateDescriptors()

Deprecated. Not for public use.

Specified by:

toTranslateDescriptors in interface IElementPresentationProvider

handle

public java.lang.Object handle(rs.sol.soloist.client.common.requests.Request request)

Handles single request from the client (browser) and returns an appropriate response. It is meant to be overriden in sub-classes.

Overrides:

handle in class rs.sol.soloist.server.builtindomains.common.ObjectOfClass

Parameters:

request - a Request from client deserialized and ready to be handeled

Returns:

an Object representing the server's response to a request

readElement

@Deprecated
public rs.sol.soloist.client.common.info.element.ElementInfo readElement(rs.sol.soloist.client.common.descr.Descr descr)

Deprecated. Not for public use.

readElements

@Deprecated
public java.util.List<rs.sol.soloist.client.common.info.element.ElementInfo> readElements(java.util.List<rs.sol.soloist.client.common.descr.Descr> descrs)

Deprecated. Not for public use.

readSlot

@Deprecated
public rs.sol.soloist.client.common.ValuesAsDescrResult readSlot(rs.sol.soloist.client.common.descr.Descr slotDescr)
                                                          throws rs.sol.soloist.client.common.SlotNotFoundException

Deprecated. Not for public use.

Throws:

rs.sol.soloist.client.common.SlotNotFoundException

readSlotAsInfo

@Deprecated
public rs.sol.soloist.client.common.ValuesAsInfoResult readSlotAsInfo(rs.sol.soloist.client.common.descr.Descr slotDescr)
                                                               throws rs.sol.soloist.client.common.SlotNotFoundException

Deprecated. Not for public use.

Throws:

rs.sol.soloist.client.common.SlotNotFoundException

readSubnodes

@Deprecated
public rs.sol.soloist.client.common.info.element.SubnodesInfo readSubnodes(rs.sol.soloist.client.common.descr.Descr descr)

Deprecated. Not for public use.

addValueToSlot

@Deprecated
public rs.sol.soloist.client.common.requests.HasNotificationsResult addValueToSlot(rs.sol.soloist.client.common.descr.Descr slotDescr,
                                                                                              java.io.Serializable value)

Deprecated. Not for public use.

removeValueFromSlot

@Deprecated
public rs.sol.soloist.client.common.requests.HasNotificationsResult removeValueFromSlot(rs.sol.soloist.client.common.descr.Descr slotDescr,
                                                                                                   java.io.Serializable value)

Deprecated. Not for public use.

setSlot

@Deprecated
public rs.sol.soloist.client.common.requests.HasNotificationsResult setSlot(rs.sol.soloist.client.common.descr.Descr slotDescr,
                                                                                       java.io.Serializable value)

Deprecated. Not for public use.

clearSlot

@Deprecated
public rs.sol.soloist.client.common.requests.HasNotificationsResult clearSlot(rs.sol.soloist.client.common.descr.Descr slotDescr)

Deprecated. Not for public use.

setSlot

@Deprecated
public rs.sol.soloist.client.common.requests.HasNotificationsResult setSlot(rs.sol.soloist.client.common.descr.Descr slotDescr,
                                                                                       java.util.List<java.io.Serializable> values)

Deprecated. Not for public use.

updateInfo

@Deprecated
public void updateInfo(java.lang.Object info)

Deprecated. Not for public use.

Specified by:

updateInfo in interface IUpdatable

getApplication

public GUIApplicationComponent getApplication()

Returns the owner GUIApplicationComponent of this widget.

Returns:

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

ipEnabled

public ISlot<?> ipEnabled()

A getter of an input pin responsible for enabling or disabling this widget. The pin should be connected to an output pin that provides a boolean value to enable or disable this widget.

Returns:

an input pin responsible for enabling or disabling this widget

See Also:

GUIComponentBinding

ipVisible

public ISlot<?> ipVisible()

A getter of an input pin responsible for making this widget visible or invisible. The pin should be connected to an output pin that provides a boolean value to make this widget visible or invisible.

Returns:

an input pin responsible for making this widget visible or invisible

See Also:

GUIComponentBinding

ipShow

public ISlot<?> ipShow()

A getter of an input pin responsible for making all the ancestors of this widget in the GUI tree show their sub-tree that contains this widget. For example, if this widget is somewhere deep in the part of the deck panel's hierarchy that is currently not visible, after receiving any kind of value on this pin, it will make the deck show its sub-tree that contains this widget, no matter how deep this widget is. And so on for all of its ancestors. In other words, new value on this pin will make this widget visible.

The pin can be connected to an output pin that provides any type of value. Only the event is what is important.

Returns:

an input pin responsible for making this widget's ancestors show this widget

See Also:

GUIComponentBinding

ipShowInParent

public ISlot<?> ipShowInParent()

A getter of an input pin responsible for making the first ancestor of this widget in the GUI tree show its sub-tree rooted at this widget. For example, if this widget is (currently invisible) first- level child of a deck panel, after receiving any kind of value on this pin, it will make the deck show it.

The pin can be connected to an output pin that provides any type of value. Only the event is what is important.

Returns:

an input pin responsible for making this widget's first ancestor show this widget

See Also:

GUIComponentBinding

ipInit

public ISlot<?> ipInit()

A getter of an input pin responsible for (re)initialization of this widget.

The pin can be connected to an output pin that provides any type of value. Only the event is what is important.

Returns:

an input pin responsible for (re)initialization of this widget.

See Also:

GUIComponentBinding

ipAddStyle

public ISlot<?> ipAddStyle()

A getter of an input pin responsible for adding a CSS style to this widget. The pin should be connected to an output pin that provides a String value of the style to be added.

Returns:

an input pin responsible for adding a CSS style to this widget.

See Also:

GUIComponentBinding

ipRemoveStyle

public ISlot<?> ipRemoveStyle()

A getter of an input pin responsible for removing a CSS style from this widget. The pin should be connected to an output pin that provides a String value of the style to be removed.

Returns:

an input pin responsible for adding a CSS style to this widget.

See Also:

GUIComponentBinding

getEnabled

public boolean getEnabled()

Tells whether this widget is enabled or disabled.

Returns:

a boolean that tells if this widget is enabled or disabled

getVisible

public boolean getVisible()

Tells whether this widget is visible or not.

Returns:

a boolean that tells if this widget is visible or not

setVisible

public void setVisible(boolean visible)

Sets the visibility of this widget.

Parameters:

visible - a boolean that specifies visibility of this widget

setEnabled

public void setEnabled(boolean enabled)

Sets this widget to be enabled or disabled.

Parameters:

enabled - a boolean that enables or disables this widget

getName

public java.lang.String getName()

Returns the name of this widget. The name can be important for widgets that serve as a parameter providers in GUISearchPanelComponent.

Returns:

the name of this widget

setName

public void setName(java.lang.String name)

Sets the name of this widget. The name can be important for widgets that serve as a parameter providers in GUISearchPanelComponent.

Parameters:

name - the new name of this widget

getDescription

public java.lang.String getDescription()

Returns the description of this widget.

Returns:

the description of this widget

setDescription

public void setDescription(java.lang.String desc)

Sets the description of this widget.

Parameters:

desc - the new description of this widget

getStyle

public java.lang.String getStyle()

Returns the CSS style of this widget.

Returns:

the CSS style of this widget

See Also:

setStyle(String)

setStyle

public void setStyle(java.lang.String style)

Sets the CSS style of this widget.

Any widget can have a style name that refers to a CSS class that fine-tunes the appearance of that widget in the browser. Of course, if this is omitted, the widget will use the default style. It is possible to set multiple classes separating them with single space character in the "style" String. If String argument begins with the # sign, HTML id attribute will be set. You can set multiple class names and id at the same time, for example setStyle("topPanel greenBorder #news"); would set "news" as id, and "topPanel" and "greenBorder" as CSS classes. Multiple values for id attribute are not allowed and will be ignored (last occurence will be used).

Parameters:

style - the new CSS style of this widget

getTooltip

public java.lang.String getTooltip()

Returns the tooltip of this widget.

Returns:

the tooltip of this widget

setTooltip

public void setTooltip(java.lang.String tooltip)

Sets the tooltip of this widget.

Parameters:

tooltip - the tooltip of this widget

setContext

public void setContext(GUIContext c)

Sets the GUIContext to this widget.

Parameters:

c - the GUIContext whose settings and features are to be applied for this widget and its sub-tree (if it has one)

See Also:

GUIContext

setLayoutData

public void setLayoutData(LayoutData ld)

Sets the LayoutData to this widget.

Parameters:

ld - the LayoutData that defines this widget's specifc layout properties in the context of its parent widget

See Also:

Layout

getLayoutData

public LayoutData getLayoutData()

Returns the LayoutData for this widget.

Returns:

the LayoutData that defines this widget's specifc layout properties in the context of its parent widget

See Also:

Layout

setSize

public void setSize(java.lang.String width,
                    java.lang.String height)

Sets the size of this widget. It is applicable for each widget and each type of the layout its parent prescribes.

Parameters:

width - the object's new width, in CSS units ("10px", "1em")

height - the object's new height, in CSS units ("10px", "1em")

setCellSize

public void setCellSize(java.lang.String width,
                        java.lang.String height)

Sets the size of this widget's container cell. It is applicable only on those widgets that are placed into horizontal, vertical, or tabular layouts, that is, that have CellLayoutData or its sub-class object assigned to.

Parameters:

width - the cell's new width, in CSS units ("10px", "1em")

height - the cell's new height, in CSS units ("10px", "1em")

See Also:

setSize(String, String)

setCellStyle

public void setCellStyle(java.lang.String style)

Sets the CSS style this widget's container cell. It is applicable only on those widgets that are placed into horizontal, vertical, or tabular layouts, that is, that have CellLayoutData or its sub-class object assigned to.

Parameters:

style - the cell's new CSS style

setCellAlignment

public void setCellAlignment(HorizontalAlignment ha,
                             VerticalAlignment va)

Sets the horizontal and vertical alignment of this widget's container cell. It is applicable only on those widgets that are placed into horizontal, vertical, or tabular layouts, that is, that have CellLayoutData or its sub-class object assigned to.

Parameters:

ha - the new HorizontalAlignment of this widget's cell. Null is accepted with no harm.

va - the new VerticalAlignment of this widget's cell. Null is accepted with no harm.

setRowColumn

public void setRowColumn(int row,
                         int column)

Sets the row and column indices for this widget. It is applicable only if this widget is placed into a tabular layout.

Parameters:

row - the new row index of this widget in a table

column - the new column index of this widget in a table

See Also:

TableLayout

setRowColumn

public void setRowColumn(int row,
                         int column,
                         int rowSpan,
                         int colSpan)

Sets the row and column indices for this widget. It is applicable only if this widget is placed into a tabular layout.

Parameters:

row - the new row index of this widget in a table

column - the new column index of this widget in a table

rowSpan - the new row span of this widget in a table

colSpan - the new col span of this widget in a table

See Also:

TableLayout

setXY

public void setXY(int x,
                  int y)

Sets the x and y coordinates of this widget. It is applicable only if this widget is placed into an absolute (xy) layout.

Parameters:

x - the x coordinate of this widget in an absolute panel

y - the y coordinate of this widget in an absolute panel

See Also:

XYLayout

setCenter

public void setCenter()

Places this widget in a central position in a dock layout.

See Also:

DockLayout

setDirectionAndSize

public void setDirectionAndSize(DockLayoutDirection direction,
                                double size)

Sets this widget position and size in a dock layout.

Parameters:

direction - the position (direction) of this widget in a dock layout

size - the size of this widget in a dock layout

See Also:

DockLayout

setLeftRightWidth

public void setLeftRightWidth(java.lang.String left,
                              java.lang.String right,
                              java.lang.String width)

Sets this widget's horizontal constraints and width in a layer layout.

Parameters:

left - the left horizontal constraint of this widget in a layer layout

right - the right horizontal constraint of this widget in a layer layout

width - the width of this widget in a layer layout

See Also:

LayerLayout

setTopBottomHeight

public void setTopBottomHeight(java.lang.String top,
                               java.lang.String bottom,
                               java.lang.String height)

Sets this widget's vertical constraints and height in a layer layout.

Parameters:

top - the top vetical constraint of this widget in a layer layout

bottom - the bottom vertical constraint of this widget in a layer layout

height - the height of this widget in a layer layout

See Also:

LayerLayout