rs.sol.soloist.server.guiconfiguration.layout
Class LayerLayoutData

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.layout.LayoutData
                      extended by rs.sol.soloist.server.guiconfiguration.layout.LayerLayoutData
All Implemented Interfaces:
rs.sol.soloist.server.uml.concepts.IElement, IClassifierInstance, IClassInstance, IRTElement

public class LayerLayoutData
extends LayoutData

An object meant to be assigned to a widget within a panel with LayerLayout, to specify widget's layering.

For a panel and a label defined like this:

 GUIPanelComponent layer = GUIPanelComponent.createLayer(parent);
 GUILabelComponent label = GUILabelComponent.create(layer, "Hello");
 
 
a layer layout data information can be specified like this:
 LayerLayoutData layerLayoutData = new LayerLayoutData();
 layerLayoutData.setLeft("100px"); // 100px from the parent's left edge
 layerLayoutData.setRight("100px"); // 100px from the parent's right edge
 label.setLayoutData(layerLayoutData);
 
 
Or shortly:
 LayerLayoutData layerLayoutData = LayerLayoutData.create("100px", "100px", null);
 label.setLayoutData(layerLayoutData);
 
 
The same can be achieved with the code bellow, however, in general, attention should be paid when using setLeftRightWidth method and setTopBottomHeight method to ensure that widget is within the layer panel (that is, a panel with LayerLayout):
 label.setLeftRightWidth("100px", "100px", null);
 
 

It should be noted that only one of the following horizontal constraint combinations are allowed: (none), (left, width), (right, width), (left, right). The following vertical constraint combinations are allowed: (none), (top, height), (bottom, height), and (top, bottom).

Author:
SOL Expert Group
See Also:
LayoutData

Nested Class Summary
static class LayerLayoutData.FQPropertyNames
          Deprecated. Not for public use.
static class LayerLayoutData.PROPERTIES
          Deprecated. Not for public use.
 
Nested classes/interfaces inherited from class rs.sol.soloist.server.guiconfiguration.layout.LayoutData
LayoutData.Comparator<T extends LayoutData>, LayoutData.HashFunction<T extends LayoutData>, LayoutData.Unit
 
Field Summary
static IClass CLASSIFIER
          UML class reference
static java.lang.String FQ_TYPE_NAME
          Fully qualified UML class name
 IAttributeValue<Text> layerBottom
          Deprecated. Not for public use.
 IAttributeValue<Text> layerHeight
          Deprecated. Not for public use.
 IAttributeValue<Text> layerLeft
          Deprecated. Not for public use.
 IAttributeValue<Text> layerRight
          Deprecated. Not for public use.
 IAttributeValue<Text> layerTop
          Deprecated. Not for public use.
 IAttributeValue<Text> layerWidth
          Deprecated. Not for public use.
 
Fields inherited from class rs.sol.soloist.server.guiconfiguration.layout.LayoutData
allowedUnits, height, width
 
Constructor Summary
LayerLayoutData()
           
 
Method Summary
 void constructor()
          The domain-specific constructor of the Classifier.
static LayerLayoutData createLeftRight(java.lang.String left, java.lang.String right, java.lang.String width)
          Returns new LayerLayoutData object that specifies horizontally constrained layered layout for widgets in a panel that will have that object assigned to.
 rs.sol.soloist.client.common.info.layout.LayoutDataInfo createSpecificInfo()
          Creates and returns an empty serializable object of the appropriate LayoutDataInfo sub-class.
static LayerLayoutData createTopBottom(java.lang.String top, java.lang.String bottom, java.lang.String height)
          Returns new LayerLayoutData object that specifies vertically constrained layered layout for widgets in a panel that will have that object assigned to.
 void fillInfo(rs.sol.soloist.client.common.info.layout.LayoutDataInfo layoutDataInfo)
          Fills-in already created LayoutDataInfo object with values of properties of this object.
 java.lang.String getBottom()
          Returns the bottom vertical layout constraint of the widget that has this object assigned to.
 java.lang.String getHeight()
          Returns the height layout constraint of the widget that has this object assigned to.
 java.lang.String getLeft()
          Returns the left horizontal layout constraint of the widget that has this object assigned to.
 java.lang.String getRight()
          Returns the right horizontal layout constraint of the widget that has this object assigned to.
 java.lang.String getTop()
          Returns the top vertical layout constraint of the widget that has this object assigned to.
 java.lang.String getWidth()
          Returns the width layout constraint of the widget that has this object assigned to.
 void setBottom(java.lang.String b)
          Sets the bottom vertical layout constraint for the widget that has this object assigned to.
 void setHeight(java.lang.String h)
          Sets the height layout constraint for the widget that has this object assigned to.
 void setLeft(java.lang.String l)
          Sets the left horizontal layout constraint for the widget that has this object assigned to.
static void setLeftRightWidth(GUIComponent component, java.lang.String left, java.lang.String right, java.lang.String width)
          Deprecated. Not for public use.
 void setRight(java.lang.String r)
          Sets the right horizontal layout constraint for the widget that has this object assigned to.
 void setTop(java.lang.String t)
          Sets the top vertical layout constraint for the widget that has this object assigned to.
static void setTopBottomHeight(GUIComponent component, java.lang.String top, java.lang.String bottom, java.lang.String height)
          Deprecated. Not for public use.
 void setWidth(java.lang.String w)
          Sets the width layout constraint for the widget that has this object assigned to.
 void validate()
          Validates a configuration settings of this layout data.
 
Methods inherited from class rs.sol.soloist.server.guiconfiguration.layout.LayoutData
create, create, createInfo, setSize, setSize, validateMeasureString, validateUnitString
 
Methods inherited from class rs.sol.soloist.server.builtindomains.common.ObjectOfClass
handle
 
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, destructor, 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, destructor, 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

layerLeft

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

layerRight

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

layerWidth

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

layerTop

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

layerBottom

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

layerHeight

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

LayerLayoutData

public LayerLayoutData()
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 LayoutData

validate

public void validate()
Description copied from class: LayoutData
Validates a configuration settings of this layout data.

Overrides:
validate in class LayoutData

createSpecificInfo

public rs.sol.soloist.client.common.info.layout.LayoutDataInfo createSpecificInfo()
Description copied from class: LayoutData
Creates and returns an empty serializable object of the appropriate LayoutDataInfo sub-class. The returned object must be able to transmit every property of objects of this class from server to clients (browsers).

Overrides:
createSpecificInfo in class LayoutData
Returns:
a LayoutDataInfo sub-class instance

fillInfo

public void fillInfo(rs.sol.soloist.client.common.info.layout.LayoutDataInfo layoutDataInfo)
Description copied from class: LayoutData
Fills-in already created LayoutDataInfo object with values of properties of this object.

Overrides:
fillInfo in class LayoutData
Parameters:
layoutDataInfo - a LayoutDataInfo sub-class object to be filled-in
See Also:
LayoutData.createSpecificInfo()

createLeftRight

public static LayerLayoutData createLeftRight(java.lang.String left,
                                              java.lang.String right,
                                              java.lang.String width)
Returns new LayerLayoutData object that specifies horizontally constrained layered layout for widgets in a panel that will have that object assigned to.

Parameters:
left - the left horizontal layout constraint
right - the right horizontal layout constraint
width - the width layout constraint
Returns:
new LayerLayoutData object that specifies horizontally constrained layered layout

createTopBottom

public static LayerLayoutData createTopBottom(java.lang.String top,
                                              java.lang.String bottom,
                                              java.lang.String height)
Returns new LayerLayoutData object that specifies vertically constrained layered layout for widgets in a panel that will have that object assigned to.

Parameters:
top - the top vertical layout constraint
bottom - the bottom vertical layout constraint
height - the height layout constraint
Returns:
new LayerLayoutData object that specifies vertically constrained layered layout

setLeft

public void setLeft(java.lang.String l)
Sets the left horizontal layout constraint for the widget that has this object assigned to.

Parameters:
l - the left horizontal layout constraint

setRight

public void setRight(java.lang.String r)
Sets the right horizontal layout constraint for the widget that has this object assigned to.

Parameters:
r - the right horizontal layout constraint

setTop

public void setTop(java.lang.String t)
Sets the top vertical layout constraint for the widget that has this object assigned to.

Parameters:
t - the top vertical layout constraint

setBottom

public void setBottom(java.lang.String b)
Sets the bottom vertical layout constraint for the widget that has this object assigned to.

Parameters:
b - the bottom vertical layout constraint

setWidth

public void setWidth(java.lang.String w)
Sets the width layout constraint for the widget that has this object assigned to.

Overrides:
setWidth in class LayoutData
Parameters:
w - the width layout constraint

setHeight

public void setHeight(java.lang.String h)
Sets the height layout constraint for the widget that has this object assigned to.

Overrides:
setHeight in class LayoutData
Parameters:
h - the height layout constraint

getLeft

public java.lang.String getLeft()
Returns the left horizontal layout constraint of the widget that has this object assigned to.

Returns:
the left horizontal layout constraint

getRight

public java.lang.String getRight()
Returns the right horizontal layout constraint of the widget that has this object assigned to.

Returns:
the right horizontal layout constraint

getTop

public java.lang.String getTop()
Returns the top vertical layout constraint of the widget that has this object assigned to.

Returns:
the top vertical layout constraint

getBottom

public java.lang.String getBottom()
Returns the bottom vertical layout constraint of the widget that has this object assigned to.

Returns:
the bottom vertical layout constraint

getWidth

public java.lang.String getWidth()
Returns the width layout constraint of the widget that has this object assigned to.

Overrides:
getWidth in class LayoutData
Returns:
the width layout constraint

getHeight

public java.lang.String getHeight()
Returns the height layout constraint of the widget that has this object assigned to.

Overrides:
getHeight in class LayoutData
Returns:
the height layout constraint

setLeftRightWidth

@Deprecated
public static void setLeftRightWidth(GUIComponent component,
                                                java.lang.String left,
                                                java.lang.String right,
                                                java.lang.String width)
Deprecated. Not for public use.


setTopBottomHeight

@Deprecated
public static void setTopBottomHeight(GUIComponent component,
                                                 java.lang.String top,
                                                 java.lang.String bottom,
                                                 java.lang.String height)
Deprecated. Not for public use.