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

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.CellLayoutData
All Implemented Interfaces:
rs.sol.soloist.server.uml.concepts.IElement, IClassifierInstance, IClassInstance, IRTElement
Direct Known Subclasses:
TableLayoutData

public class CellLayoutData
extends LayoutData

An object meant to be assigned to a widget within a panel with HorizontalLayout or VerticalLayout to specify widget's alignment, style, and size.

For a panel and a label defined like this:

 GUIPanelComponent horizontal = GUIPanelComponent.createHorizontal(parent);
 GUILabelComponent label = GUILabelComponent.create(horizontal, "Hello");
 
 
a cell layout data information can be specified like this:
 CellLayoutData cellLayoutData = new CellLayoutData();
 cellLayoutData.setCellWidth("200px");
 cellLayoutData.setCellHeight("20px");
 label.setLayoutData(cellLayoutData);
 
 
The same can be achieved with the code bellow, however, in general, attention should be paid when using setCellSize method, setCellStyle method, and setCellAlignment method to ensure that widget is within the cell panel (that is, a panel with HorizontalLayout, VerticalLayout, or TableLayout):
 label.setCellSize("200px", "20px");
 
 

Author:
SOL Expert Group
See Also:
LayoutData

Nested Class Summary
static class CellLayoutData.Comparator<T extends CellLayoutData>
          Deprecated. Not for public use.
static class CellLayoutData.FQPropertyNames
          Deprecated. Not for public use.
static class CellLayoutData.HashFunction<T extends CellLayoutData>
          Deprecated. Not for public use.
static class CellLayoutData.PROPERTIES
          Deprecated. Not for public use.
 
Nested classes/interfaces inherited from class rs.sol.soloist.server.guiconfiguration.layout.LayoutData
LayoutData.Unit
 
Field Summary
 IAttributeValue<Text> cellHeight
          Deprecated. Not for public use.
 IAttributeValue<Text> cellWidth
          Deprecated. Not for public use.
static IClass CLASSIFIER
          UML class reference
static java.lang.String FQ_TYPE_NAME
          Fully qualified UML class name
 IAttributeValue<HorizontalAlignment> horizontalAlignment
          Deprecated. Not for public use.
 IAttributeValue<Text> styleName
          Deprecated. Not for public use.
 IAttributeValue<VerticalAlignment> verticalAlignment
          Deprecated. Not for public use.
 
Fields inherited from class rs.sol.soloist.server.guiconfiguration.layout.LayoutData
allowedUnits, height, width
 
Constructor Summary
CellLayoutData()
           
 
Method Summary
 void constructor()
          The domain-specific constructor of the Classifier.
static CellLayoutData create(java.lang.String width, java.lang.String height)
          Returns new CellLayoutData object that specifies a single widget (the one that will have this object assigned to) in a CellLayout in terms of widget's width and height.
static CellLayoutData create(java.lang.String width, java.lang.String height, java.lang.String cellWidth, java.lang.String cellHeight)
          Returns new CellLayoutData object that specifies both a single cell and the corresponding widget (the one that will have this object assigned to) in a CellLayout in terms of their width, height.
 rs.sol.soloist.client.common.info.layout.CellLayoutDataInfo createSpecificInfo()
          Creates and returns an empty serializable object of the appropriate LayoutDataInfo sub-class.
 void fillInfo(rs.sol.soloist.client.common.info.layout.LayoutDataInfo info1)
          Fills-in already created LayoutDataInfo object with values of properties of this object.
 java.lang.String getCellHeight()
          Returns a cell height.
 java.lang.String getCellWidth()
          Returns a cell width.
 HorizontalAlignment getHorizontalAlignment()
          Returns a horizontal alignment of a single widget (the one that has this object assigned to) in a cell layout: LEFT, RIGHT, or CENTER.
 java.lang.String getStyleName()
          Returns a cell CSS style.
 VerticalAlignment getVerticalAlignment()
          Returns a vertical alignment of a single widget (the one that has this object assigned to) in a cell layout: TOP, BOTTOM, or MIDDLE.
static void setAlignment(GUIComponent component, HorizontalAlignment horizontalAlignment)
          Deprecated. Not for public use.
static void setAlignment(GUIComponent component, HorizontalAlignment horizontalAlignment, VerticalAlignment verticalAlignment)
          Deprecated. Not for public use.
static void setAlignment(GUIComponent component, VerticalAlignment verticalAlignment)
          Deprecated. Not for public use.
 void setCellHieght(java.lang.String h)
          Sets the height of a single cell (the one whose widget has this object assigned to) in a cell layout.
static void setCellSize(GUIComponent component, java.lang.String width, java.lang.String height)
          Deprecated. Not for public use.
 void setCellWidth(java.lang.String w)
          Sets the width of a single cell (the one whose widget has this object assigned to) in a cell layout.
 void setHorizontalAlignment(HorizontalAlignment ha)
          Sets a horizontal alignment of a single widget (the one that has this object assigned to) in a cell layout: LEFT, RIGHT, or CENTER.
static void setStyleName(GUIComponent component, java.lang.String styleName)
          Deprecated. Not for public use.
 void setStyleName(java.lang.String style)
          Sets the CSS style for a single cell (the one whose widget has this object assigned to) in a cell layout.
 void setVerticalAlignment(VerticalAlignment va)
          Sets a vertical alignment of a single widget (the one that has this object assigned to) in a cell layout: TOP, BOTTOM, or MIDDLE.
 void validate()
          Validates a configuration settings of this layout data.
 
Methods inherited from class rs.sol.soloist.server.guiconfiguration.layout.LayoutData
create, createInfo, getHeight, getWidth, setHeight, setSize, setSize, setWidth, 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

horizontalAlignment

@Deprecated
public IAttributeValue<HorizontalAlignment> horizontalAlignment
Deprecated. Not for public use.

verticalAlignment

@Deprecated
public IAttributeValue<VerticalAlignment> verticalAlignment
Deprecated. Not for public use.

cellWidth

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

cellHeight

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

styleName

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

CellLayoutData

public CellLayoutData()
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.CellLayoutDataInfo 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 info1)
Description copied from class: LayoutData
Fills-in already created LayoutDataInfo object with values of properties of this object.

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

create

public static CellLayoutData create(java.lang.String width,
                                    java.lang.String height)
Returns new CellLayoutData object that specifies a single widget (the one that will have this object assigned to) in a CellLayout in terms of widget's width and height.

Parameters:
width - the width of the widget
height - the height of the widget
Returns:
new CellLayoutData object that specifies a single widget in terms of its width and height

create

public static CellLayoutData create(java.lang.String width,
                                    java.lang.String height,
                                    java.lang.String cellWidth,
                                    java.lang.String cellHeight)
Returns new CellLayoutData object that specifies both a single cell and the corresponding widget (the one that will have this object assigned to) in a CellLayout in terms of their width, height.

Parameters:
width - the width of the widget
height - the height of the widget
cellWidth - the width of the cell
cellHeight - the height of the cell
Returns:
new CellLayoutData object that specifies both a single cell and the corresponding widget in terms of their width and height

setHorizontalAlignment

public void setHorizontalAlignment(HorizontalAlignment ha)
Sets a horizontal alignment of a single widget (the one that has this object assigned to) in a cell layout: LEFT, RIGHT, or CENTER. Redefines what is specified in CellLayout.setHorizontalAlignment(HorizontalAlignment) method.

Parameters:
ha - a horizontal alignment enumeration

setVerticalAlignment

public void setVerticalAlignment(VerticalAlignment va)
Sets a vertical alignment of a single widget (the one that has this object assigned to) in a cell layout: TOP, BOTTOM, or MIDDLE. Redefines what is specified in CellLayout.setVerticalAlignment(VerticalAlignment) method.

Parameters:
va - a vertical alignment enumeration

setCellWidth

public void setCellWidth(java.lang.String w)
Sets the width of a single cell (the one whose widget has this object assigned to) in a cell layout.

Parameters:
w - the width of a single cell

setCellHieght

public void setCellHieght(java.lang.String h)
Sets the height of a single cell (the one whose widget has this object assigned to) in a cell layout.

Parameters:
h - the height of a single cell

setStyleName

public void setStyleName(java.lang.String style)
Sets the CSS style for a single cell (the one whose widget has this object assigned to) in a cell layout.

Parameters:
style - the CSS style of a single cell

getCellWidth

public java.lang.String getCellWidth()
Returns a cell width.

Returns:
a cell width

getCellHeight

public java.lang.String getCellHeight()
Returns a cell height.

Returns:
a cell height

getStyleName

public java.lang.String getStyleName()
Returns a cell CSS style.

Returns:
a cell CSS style

getHorizontalAlignment

public HorizontalAlignment getHorizontalAlignment()
Returns a horizontal alignment of a single widget (the one that has this object assigned to) in a cell layout: LEFT, RIGHT, or CENTER.

Returns:
a horizontal alignment enumeration

getVerticalAlignment

public VerticalAlignment getVerticalAlignment()
Returns a vertical alignment of a single widget (the one that has this object assigned to) in a cell layout: TOP, BOTTOM, or MIDDLE.

Returns:
a vertical alignment enumeration

setAlignment

@Deprecated
public static void setAlignment(GUIComponent component,
                                           HorizontalAlignment horizontalAlignment)
Deprecated. Not for public use.


setAlignment

@Deprecated
public static void setAlignment(GUIComponent component,
                                           VerticalAlignment verticalAlignment)
Deprecated. Not for public use.


setAlignment

@Deprecated
public static void setAlignment(GUIComponent component,
                                           HorizontalAlignment horizontalAlignment,
                                           VerticalAlignment verticalAlignment)
Deprecated. Not for public use.


setCellSize

@Deprecated
public static void setCellSize(GUIComponent component,
                                          java.lang.String width,
                                          java.lang.String height)
Deprecated. Not for public use.


setStyleName

@Deprecated
public static void setStyleName(GUIComponent component,
                                           java.lang.String styleName)
Deprecated. Not for public use.