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

java.lang.Object
  extended by rs.sol.soloist.server.uml.commonimplementation.runtime._ClassifierInstance
      extended by rs.sol.soloist.server.uml.commonimplementation.runtime._ClassInstance
          extended by rs.sol.soloist.server.javaimpl.runtime.SOLoistClassInstance
              extended by rs.sol.soloist.server.builtindomains.common.ObjectOfClass
                  extended by rs.sol.soloist.server.guiconfiguration.construction.GUIComponent
                      extended by rs.sol.soloist.server.guiconfiguration.components.GUILabelComponent
All Implemented Interfaces:
IElementPresentationProvider, IUpdatable, rs.sol.soloist.server.uml.concepts.IElement, IClassifierInstance, IClassInstance, IRTElement

public class GUILabelComponent
extends GUIComponent

A widget that contains an arbitrary text. Initial text (label) can be specified by calling setLabel(String) method. In the run-time, text can dynamically change by binding other widget's output pin with this widget's label input pin ( ipLabel() method).

Author:
SOL Expert Group

Nested Class Summary
static class GUILabelComponent.FQPropertyNames
          Deprecated. Not for public use.
static class GUILabelComponent.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<Text> label
          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
GUILabelComponent()
           
GUILabelComponent(java.lang.String label)
          Deprecated.  
 
Method Summary
 void constructor()
          The domain-specific constructor of the Classifier.
 void constructor(java.lang.String label)
          Performs an initialization for this object.
static GUILabelComponent create(GUIContainerComponent parent, java.lang.String text)
          Returns new GUILabelComponent with the given text (label) and assigns it to the given parent.
static GUILabelComponent create(GUIContainerComponent parent, java.lang.String text, int row, int column)
          Returns new GUILabelComponent with the given text (label), places it in the parent's table layout according to the given row and column, and assigns it to the given parent.
static GUILabelComponent create(GUIContainerComponent parent, java.lang.String text, int row, int column, int rowSpan, int colSpan)
          Deprecated. Not for public use.
static GUILabelComponent create(GUIContainerComponent parent, java.lang.String text, LayoutData layoutData)
          Returns new GUILabelComponent with the given text (label), places it in the parent's layout according to the given LayoutData, and assigns it to the given parent.
 rs.sol.soloist.client.common.info.LabelInfo createSpecificInfo()
          Creates and returns an empty serializable object of the appropriate ComponentInfo sub-class.
 java.lang.String getLabel()
          Returns this widget label.
 ISlot<?> ipLabel()
          Returns the label input pin; when event occurs, the textual content from the binding message will be used to set this widget's label.
 void setLabel(java.lang.String label)
          Sets this widget label.
 
Methods inherited from class rs.sol.soloist.server.guiconfiguration.construction.GUIComponent
addStyleNames, addValueToSlot, clearSlot, clone, createInfo, createInfoAlreadyValidated, destructor, fillElementInfo, getApplication, 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

label

@Deprecated
public IAttributeValue<Text> label
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

Constructor Detail

GUILabelComponent

@Deprecated
public GUILabelComponent(java.lang.String label)
Deprecated. 


GUILabelComponent

public GUILabelComponent()
Method Detail

constructor

public void constructor(java.lang.String label)
Performs an initialization for this object. It is internally called during the construction.

Parameters:
label - the String containing an arbitrary text to be displayed

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.LabelInfo 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 GUILabelComponent create(GUIContainerComponent parent,
                                       java.lang.String text)
Returns new GUILabelComponent with the given text (label) and assigns it to the given parent.

Parameters:
parent - the parent GUIContainerComponent widget
text - the label's text or label
Returns:
new GUILabelComponent

create

public static GUILabelComponent create(GUIContainerComponent parent,
                                       java.lang.String text,
                                       LayoutData layoutData)
Returns new GUILabelComponent with the given text (label), places it in the parent's layout according to the given LayoutData, and assigns it to the given parent.

Parameters:
parent - the parent GUIContainerComponent widget
text - the label's text or label
layoutData - the layout data of the new label
Returns:
new GUILabelComponent

create

public static GUILabelComponent create(GUIContainerComponent parent,
                                       java.lang.String text,
                                       int row,
                                       int column)
Returns new GUILabelComponent with the given text (label), places it in the parent's table layout according to the given row and column, and assigns it to the given parent.

Parameters:
parent - the parent GUIContainerComponent widget
text - the label's text or label
row - the row in the parent table
column - the column in the parent table
Returns:
new GUILabelComponent

ipLabel

public ISlot<?> ipLabel()
Returns the label input pin; when event occurs, the textual content from the binding message will be used to set this widget's label.

Returns:
the label input pin
See Also:
GUIComponentBinding

getLabel

public java.lang.String getLabel()
Returns this widget label.

Returns:
this widget label
See Also:
setLabel(String)

setLabel

public void setLabel(java.lang.String label)
Sets this widget label.

Parameters:
label - new widget's label

create

@Deprecated
public static GUILabelComponent create(GUIContainerComponent parent,
                                                  java.lang.String text,
                                                  int row,
                                                  int column,
                                                  int rowSpan,
                                                  int colSpan)
Deprecated. Not for public use.