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

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

All Implemented Interfaces:

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

public class DockLayout
extends Layout

An object meant to be assigned to a panel to give it a dock spatial arrangement for its children. In that case, a children shoud have a DockLayoutData object assigned for additional child-specific layout adjustments.

Dock layouts should be used in the following way:

 DockLayout dLayout = new DockLayout();
 dLayout.setUnits("px");
 
 GUIPanelComponent dock = GUIPanelComponent.create(parent, dLayout);
 
 

Or shortly using a general factory method:

 DockLayout dLayout = DockLayout.create("px");
 GUIPanelComponent dock = GUIPanelComponent.create(parent, dLayout);
 
 

Or even shorter using specific factory method:

 GUIPanelComponent dock = GUIPanelComponent.createDock(parent, "px");
 
 

Author:

SOL Expert Group

See Also:

Layout

Nested Class Summary

static class	DockLayout.FQPropertyNames Deprecated. Not for public use.
static class	DockLayout.PROPERTIES Deprecated. Not for public use.

Field Summary

static IClass	CLASSIFIER UML class reference
static java.lang.String	FQ_TYPE_NAME Fully qualified UML class name
IAttributeValue<Text>	units Deprecated. Not for public use.

Constructor Summary

DockLayout()

DockLayout(java.lang.String units)
Deprecated.

Method Summary

void	constructor() The domain-specific constructor of the Classifier.
void	constructor(java.lang.String units) Performs an initialization for this object.
static DockLayout	create(java.lang.String units) Returns new DockLayout object that specifies dock layout for all widgets in a panel that has this object assigned to.
rs.sol.soloist.client.common.info.layout.DockLayoutInfo	createSpecificInfo() Creates and returns an empty serializable object of the appropriate LayoutInfo sub-class.
void	fillInfo(rs.sol.soloist.client.common.info.layout.LayoutInfo layoutInfo) Fills-in already created LayoutInfo object with values of properties of this object.
IClass	getLayoutDataClass() Deprecated. Not for public use.
java.lang.String	getUnits() Returns the units used in this layout.
void	setUnits(java.lang.String units) Sets the units for this type of layout.
void	validate() Validates a configuration settings of this object.

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

createInfo, createLayoutData, validate, validate

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

units

@Deprecated
public IAttributeValue<Text> units

Deprecated. Not for public use.

One of:

• em
• px
• %
• ex
• cm
• mm
• in
• pt
• pc

All children's layout data have to use the same unit.

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

DockLayout

@Deprecated
public DockLayout(java.lang.String units)

Deprecated.

DockLayout

public DockLayout()

Method Detail

constructor

public void constructor(java.lang.String units)

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

Parameters:

units - the String designating the units to be used in this layout (em, px, %, mm, cm, ex, in, pt, pc)

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 Layout

validate

public void validate()

Description copied from class: Layout

Validates a configuration settings of this object.

Overrides:

validate in class Layout

getLayoutDataClass

@Deprecated
public IClass getLayoutDataClass()

Deprecated. Not for public use.

Description copied from class: Layout

Returns the Class of layout data appropriate for this layout. It may return null if no layout data is needed.

Specified by:

getLayoutDataClass in class Layout

createSpecificInfo

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

Description copied from class: Layout

Creates and returns an empty serializable object of the appropriate LayoutInfo sub-class. The returned object must be able to transmit every property of objects of this class from server to clients (browsers).

Specified by:

createSpecificInfo in class Layout

Returns:

a LayoutInfo sub-class instance

fillInfo

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

Description copied from class: Layout

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

Overrides:

fillInfo in class Layout

Parameters:

layoutInfo - a LayoutInfo sub-class object to be filled-in

See Also:

Layout.createSpecificInfo()

create

public static DockLayout create(java.lang.String units)

Returns new DockLayout object that specifies dock layout for all widgets in a panel that has this object assigned to.

Parameters:

units - units to be used in dock layout specification. One of: em, px, %, mm, cm, ex, in, pt, pc.

Returns:

new DockLayout object

setUnits

public void setUnits(java.lang.String units)

Sets the units for this type of layout.

Parameters:

units - units to be used in this dock layout. One of: em, px, %, mm, cm, ex, in, pt, pc.

getUnits

public java.lang.String getUnits()

Returns the units used in this layout.

Returns:

the units used in this layout. One of: em, px, %, mm, cm, ex, in, pt, pc.