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

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.layout.LayoutData

All Implemented Interfaces:

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

Direct Known Subclasses:

CellLayoutData, DockLayoutData, LayerLayoutData, XYLayoutData

public class LayoutData
extends rs.sol.soloist.server.builtindomains.common.ObjectOfClass

Specifies an additional layout-related information that are relevant in the context of the widget's parent. In other words, in addition to setting a layout for a panel, sometimes it is necessary to specify additional layout-related detials for each of the panel's children independently which is done using this object.

The additional information means setting the widget's width and height, the width and height of the widget's cell, horizontal and vertical alignment within the widget's cell, CSS style, absolute or table coordinates, direction, layer, etc. Only part of these are relevant depending on the type of widget's parent GUIPanelComponent layout.

Every type of Layout has a corresponding type of LayoutData. This means when decision is made to use a certain type of Layout, it unambiguously determines what type of LayoutData must be used along with it.

Author:

SOL Expert Group

See Also:

CellLayoutData, XYLayoutData, DockLayoutData, LayerLayoutData, TableLayoutData

Nested Class Summary

static class	LayoutData.Comparator<T extends LayoutData> Deprecated. Not for public use.
static class	LayoutData.FQPropertyNames Deprecated. Not for public use.
static class	LayoutData.HashFunction<T extends LayoutData> Deprecated. Not for public use.
static class	LayoutData.PROPERTIES Deprecated. Not for public use.
static class	LayoutData.Unit Deprecated. Not for public use.

Field Summary

static java.lang.String[]	allowedUnits 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>	height Deprecated. Not for public use.
IAttributeValue<Text>	width Deprecated. Not for public use.

Constructor Summary

LayoutData()

Method Summary

void	constructor() The domain-specific constructor of the Classifier.
static LayoutData	create(GUIComponent component) Deprecated.
static LayoutData	create(java.lang.String width, java.lang.String height) Returns new LayoutData object that specifies width and height of the widget in a panel that will have that object assigned to.
rs.sol.soloist.client.common.info.layout.LayoutDataInfo	createInfo() Deprecated. Not for public use.
rs.sol.soloist.client.common.info.layout.LayoutDataInfo	createSpecificInfo() Creates and returns an empty serializable object of the appropriate LayoutDataInfo sub-class.
void	fillInfo(rs.sol.soloist.client.common.info.layout.LayoutDataInfo info) Fills-in already created LayoutDataInfo object with values of properties of this object.
java.lang.String	getHeight() Returns the height of the widget that has this object assigned to.
java.lang.String	getWidth() Returns the width of the widget that has this object assigned to.
void	setHeight(java.lang.String h) Sets the height of the widget that has this object assigned to.
static void	setSize(GUIComponent component, java.lang.String width, java.lang.String height) Deprecated. Not for public use.
void	setSize(java.lang.String w, java.lang.String h) Sets the size of the widget that has this object assigned to.
void	setWidth(java.lang.String w) Sets the width of the widget that has this object assigned to.
void	validate() Validates a configuration settings of this layout data.
static void	validateMeasureString(ISlot<Text> slot) Deprecated. Not for public use.
static void	validateUnitString(ISlot<Text> slot) Deprecated. Not for public use.

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

width

@Deprecated
public final IAttributeValue<Text> width

Deprecated. Not for public use.

height

@Deprecated
public final IAttributeValue<Text> height

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

allowedUnits

@Deprecated
public static final java.lang.String[] allowedUnits

Deprecated. Not for public use.

Constructor Detail

LayoutData

public LayoutData()

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

validate

public void validate()

Validates a configuration settings of this layout data.

Throws:

IllegalComponentStateException - If this layout data is misconfigured.

validateUnitString

@Deprecated
public static void validateUnitString(ISlot<Text> slot)

Deprecated. Not for public use.

validateMeasureString

@Deprecated
public static void validateMeasureString(ISlot<Text> slot)

Deprecated. Not for public use.

createSpecificInfo

public rs.sol.soloist.client.common.info.layout.LayoutDataInfo createSpecificInfo()

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).

Returns:

a LayoutDataInfo sub-class instance

createInfo

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

Deprecated. Not for public use.

fillInfo

public void fillInfo(rs.sol.soloist.client.common.info.layout.LayoutDataInfo info)

Fills-in already created LayoutDataInfo object with values of properties of this object.

Parameters:

info - a LayoutDataInfo sub-class object to be filled-in

See Also:

createSpecificInfo()

create

public static LayoutData create(java.lang.String width,
                                java.lang.String height)

Returns new LayoutData object that specifies width and height of the widget in a panel that will have that object assigned to.

Parameters:

width - the width of the widget

height - the height of the widget

Returns:

new LayoutData object that specifies width and height of the widget

setSize

public void setSize(java.lang.String w,
                    java.lang.String h)

Sets the size of the widget that has this object assigned to.

Parameters:

w - the width of the widget

h - the height of the widget

setWidth

public void setWidth(java.lang.String w)

Sets the width of the widget that has this object assigned to.

Parameters:

w - the width of the widget

setHeight

public void setHeight(java.lang.String h)

Sets the height of the widget that has this object assigned to.

Parameters:

h - the height of the widget

getWidth

public java.lang.String getWidth()

Returns the width of the widget that has this object assigned to.

Returns:

the width of the widget

getHeight

public java.lang.String getHeight()

Returns the height of the widget that has this object assigned to.

Returns:

the height of the widget

create

@Deprecated
public static LayoutData create(GUIComponent component)

Deprecated.

Creates appropriate layout data for specified component based on its parent's layout. Does not create layout data if the component already has one.

Returns:

new or already existing layout data of specified component

setSize

@Deprecated
public static void setSize(GUIComponent component,
                                      java.lang.String width,
                                      java.lang.String height)

Deprecated. Not for public use.