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

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.GUIContainerComponent
                          extended by rs.sol.soloist.server.guiconfiguration.components.GUITabComponent
All Implemented Interfaces:
IElementPresentationProvider, IUpdatable, rs.sol.soloist.server.uml.concepts.IElement, IClassifierInstance, IClassInstance, IRTElement
Direct Known Subclasses:
GUIDynamicallyVisibleTabsComponent

public class GUITabComponent
extends GUIContainerComponent

A container widget that displays its child widgets in a tabbed layout. Which child will be displayed in the run-time at a particular moment depends on user selecting one of this widget's tabs.

By using this widget's binding mechanism child widgets' visibility can be controlled in the run-time as well.

For index-based displaying of child widgets visibleChild input pin should be used (methods ipVisibleChild() and opVisibleChild() ).

For order-based displaying of child widgets next and previous pins should be used (methods ipNext() and ipPrevious()).

For history-based displaying of child widgets back and forward pins should be used instead (methods ipBack() and ipForward()).

Initial child visibility can be specified by calling inherited setVisibleChild(int) method.

Author:
SOL Expert Group

Nested Class Summary
static class GUITabComponent.FQPropertyNames
          Deprecated. Not for public use.
static class GUITabComponent.PROPERTIES
          Deprecated. Not for public use.
 
Field Summary
 IAttributeValue<Text> barHeight
          Deprecated. Not for public use.
static IClass CLASSIFIER
          UML class reference
static java.lang.String FQ_TYPE_NAME
          Fully qualified UML class name
 IAttributeValue<Text> tabTexts
          Deprecated. Not for public use.
 
Fields inherited from class rs.sol.soloist.server.guiconfiguration.components.GUIContainerComponent
back, children, forward, input, logger, next, output, previous, refresh, reset, submit, visibleChild
 
Fields inherited from class rs.sol.soloist.server.guiconfiguration.construction.GUIComponent
addStyle, context, description, enabled, init, inputBindings, layoutData, name, outputBindings, ownerTable, parent, removeStyle, show, showInParent, styleName, tooltip, visible
 
Constructor Summary
GUITabComponent()
           
 
Method Summary
 void constructor()
          The domain-specific constructor of the Classifier.
static GUITabComponent create(GUIContainerComponent parent, LayoutData layoutData, java.lang.String... texts)
          Returns new GUITabComponent with the given tab texts, places it in the parent's layout according to the given LayoutData, and assigns it to the given parent.
static GUITabComponent create(GUIContainerComponent parent, java.lang.String... texts)
          Returns new GUITabComponent with the given tab texts and assigns it to the given parent.
 java.lang.String getBarHeight()
          Returns the tab header height.
 java.lang.String[] getTabTexts()
          Returns the collection of tab texts.
 void setBarHeight(java.lang.String barHeight)
          Sets the tab header height.
 void setTabTexts(java.lang.String... tabTexts)
          Sets the collection of tab header texts.
 void validate()
          Validates a configuration settings of this widget.
 
Methods inherited from class rs.sol.soloist.server.guiconfiguration.components.GUIContainerComponent
add, addFirst, clear, get, getVisibleChild, ipBack, ipForward, ipNext, ipPrevious, ipRefresh, ipRelay1, ipRelay2, ipReset, ipSubmit, ipVisibleChild, opRelay1, opRelay2, opVisibleChild, remove, removeFirst, setVisibleChild, validateSingleChild
 
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, 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

tabTexts

@Deprecated
public IAttributeValue<Text> tabTexts
Deprecated. Not for public use.

barHeight

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

GUITabComponent

public GUITabComponent()
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 GUIContainerComponent

validate

public void validate()
Description copied from class: GUIComponent
Validates a configuration settings of this widget.

Overrides:
validate in class GUIContainerComponent

create

public static GUITabComponent create(GUIContainerComponent parent,
                                     java.lang.String... texts)
Returns new GUITabComponent with the given tab texts and assigns it to the given parent.

Parameters:
parent - the parent GUIContainerComponent widget
texts - an array of tab header texts
Returns:
the new GUITabComponent

create

public static GUITabComponent create(GUIContainerComponent parent,
                                     LayoutData layoutData,
                                     java.lang.String... texts)
Returns new GUITabComponent with the given tab texts, 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
layoutData - the layout data of the new tab widget
texts - an array of tab header texts
Returns:
the new GUITabComponent

getTabTexts

public java.lang.String[] getTabTexts()
Returns the collection of tab texts.

Returns:
the collection of tab texts
See Also:
setTabTexts(String...)

setTabTexts

public void setTabTexts(java.lang.String... tabTexts)
Sets the collection of tab header texts.

Parameters:
tabTexts - the collection of tab header texts

getBarHeight

public java.lang.String getBarHeight()
Returns the tab header height.

Returns:
the tab header height
See Also:
setBarHeight(String)

setBarHeight

public void setBarHeight(java.lang.String barHeight)
Sets the tab header height.

Parameters:
barHeight - the tab header height