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

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
                      rs.sol.soloist.server.guiconfiguration.layout.DockLayoutData

All Implemented Interfaces:

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

public class DockLayoutData
extends LayoutData

An object meant to be assigned to a widget within a panel with DockLayout, to specify widget's direction and size.

For a panel and a label defined like this:

 GUIPanelComponent dock = GUIPanelComponent.createDock(parent, "px");
 GUILabelComponent label = GUILabelComponent.create(dock, "Hello");
 
 

a dock layout data information can be specified like this:

 DockLayoutData dockLayoutData = new DockLayoutData();
 dockLayoutData.setSize(100.);
 dockLayoutData.setDirection(DockLayoutDirection.SOUTH);
 label.setLayoutData(dockLayoutData);
 
 

Or shortly:

 DockLayoutData dockLayoutData = DockLayoutData.create(DockLayoutDirection.SOUTH, 100.);
 label.setLayoutData(dockLayoutData);
 
 

The same can be achieved with the code bellow, however, in general, attention should be paid when using setDirectionAndSize method and setCenter method to ensure that widget is within the dock panel (that is, a panel with DockLayout):

 label.setDirectionAndSize(DockLayoutDirection.SOUTH, 100.);
 
 

Author:

SOL Expert Group

See Also:

LayoutData, DockLayoutDirection

Nested Class Summary

static class	DockLayoutData.FQPropertyNames Deprecated. Not for public use.
static class	DockLayoutData.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
IAttributeValue<DockLayoutDirection>	direction Deprecated. Not for public use.
static java.lang.String	FQ_TYPE_NAME Fully qualified UML class name
IAttributeValue<Real>	size Deprecated. Not for public use.

Fields inherited from class rs.sol.soloist.server.guiconfiguration.layout.LayoutData

allowedUnits, height, width

Constructor Summary

DockLayoutData()

DockLayoutData(DockLayoutDirection direction, double size)
Deprecated.

Method Summary

void	constructor() The domain-specific constructor of the Classifier.
void	constructor(DockLayoutDirection direction, double size) Performs an initialization for this object.
static DockLayoutData	create(DockLayoutDirection direction, double size) Returns new DockLayoutData object that specifies direction and size of the widget that will have this object assigned to.
rs.sol.soloist.client.common.info.layout.DockLayoutDataInfo	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.
DockLayoutDirection	getDirection() Returns the direction of the widget that has this object assigned to.
double	getSize() Returns the size of the object that has this widget assigned to.
static void	setCenter(GUIComponent component) Deprecated. Not for public use.
void	setDirection(DockLayoutDirection direction) Sets the direction of the widget that has this object assigned to.
static void	setDirectionAndSize(GUIComponent component, DockLayoutDirection direction, double size) Deprecated. Not for public use.
void	setSize(double size) Sets the size of the widget that has this object assigned to.

Methods inherited from class rs.sol.soloist.server.guiconfiguration.layout.LayoutData

create, create, createInfo, getHeight, getWidth, setHeight, setSize, setSize, setWidth, validate, 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

direction

@Deprecated
public IAttributeValue<DockLayoutDirection> direction

Deprecated. Not for public use.

size

@Deprecated
public IAttributeValue<Real> size

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

DockLayoutData

@Deprecated
public DockLayoutData(DockLayoutDirection direction,
                                 double size)

Deprecated.

DockLayoutData

public DockLayoutData()

Method Detail

constructor

public void constructor(DockLayoutDirection direction,
                        double size)

Performs an initialization for this object. It is internally called during the construction.

Parameters:

direction - the DockLayoutDirection to be used when placing the corresponding widget in its parent (dock) layout

size - the double to be used as a size of the corresponding widget

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

createSpecificInfo

public rs.sol.soloist.client.common.info.layout.DockLayoutDataInfo 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 DockLayoutData create(DockLayoutDirection direction,
                                    double size)

Returns new DockLayoutData object that specifies direction and size of the widget that will have this object assigned to.

Parameters:

direction - the direction of the widget (NORTH, SOUTH, WEST, EAST, CENTER)

size - the size of the widget

Returns:

new DockLayoutData object that specifies direction and size of the widget

setDirection

public void setDirection(DockLayoutDirection direction)

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

Parameters:

direction - the direction (NORTH, SOUTH, WEST, EAST, CENTER) of the widget that has this object assigned to

setSize

public void setSize(double size)

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

Parameters:

size - the size of the widget that has this object assigned to

getDirection

public DockLayoutDirection getDirection()

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

Returns:

the direction of the widget that has this object assigned to

getSize

public double getSize()

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

Returns:

the size of the object that has this widget assigned to

setCenter

@Deprecated
public static void setCenter(GUIComponent component)

Deprecated. Not for public use.

setDirectionAndSize

@Deprecated
public static void setDirectionAndSize(GUIComponent component,
                                                  DockLayoutDirection direction,
                                                  double size)

Deprecated. Not for public use.