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

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.Layout
All Implemented Interfaces:
rs.sol.soloist.server.uml.concepts.IElement, IClassifierInstance, IClassInstance, IRTElement
Direct Known Subclasses:
CellLayout, DockLayout, FlowLayout, LayerLayout, XYLayout

public abstract class Layout
extends rs.sol.soloist.server.builtindomains.common.ObjectOfClass

An abstract base class for all types of layouts: horizontal, vertical, table, dock, flow, layer, and absolute (xy). Layout object is meant to be assigned to a GUIPanelComponent in order to spatialy arrange its children. It should be noted that every type of Layout has a corresponding type of LayoutData.

Author:
SOL Expert Group
See Also:
FlowLayout, XYLayout, DockLayout, LayerLayout, HorizontalLayout, VerticalLayout, TableLayout

Nested Class Summary
static class Layout.FQPropertyNames
          Deprecated. Not for public use.
static class Layout.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
 
Constructor Summary
Layout()
           
 
Method Summary
 void constructor()
          The domain-specific constructor of the Classifier.
 rs.sol.soloist.client.common.info.layout.LayoutInfo createInfo()
          Deprecated. Not for public use.
 LayoutData createLayoutData()
          Deprecated.  
abstract  rs.sol.soloist.client.common.info.layout.LayoutInfo createSpecificInfo()
          Creates and returns an empty serializable object of the appropriate LayoutInfo sub-class.
 void fillInfo(rs.sol.soloist.client.common.info.layout.LayoutInfo info)
          Fills-in already created LayoutInfo object with values of properties of this object.
abstract  IClass getLayoutDataClass()
          Deprecated.  
 void validate()
          Validates a configuration settings of this object.
 void validate(GUIComponent component)
          Check if the layout data of the specified widget conforms to this layout.
 void validate(java.lang.Iterable<GUIComponent> components, java.util.Map<GUIComponent,IllegalComponentStateException> exceptions)
          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

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

Layout

public Layout()
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

createLayoutData

@Deprecated
public LayoutData createLayoutData()
Deprecated. 

Creates an instance of layout data of an appropriate type for this layout. It may return null if no layout data is needed.


getLayoutDataClass

@Deprecated
public abstract IClass getLayoutDataClass()
Deprecated. 

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


validate

public void validate()
Validates a configuration settings of this object.

Throws:
IllegalComponentStateException - If this object is misconfigured.

validate

public void validate(GUIComponent component)
Check if the layout data of the specified widget conforms to this layout.

Parameters:
component - the widget whose layout data is to be checked
Throws:
IllegalComponentStateException - If the widget is misconfigured.

validate

@Deprecated
public final void validate(java.lang.Iterable<GUIComponent> components,
                                      java.util.Map<GUIComponent,IllegalComponentStateException> exceptions)
Deprecated. Not for public use.


createInfo

@Deprecated
public final rs.sol.soloist.client.common.info.layout.LayoutInfo createInfo()
Deprecated. Not for public use.


createSpecificInfo

public abstract rs.sol.soloist.client.common.info.layout.LayoutInfo createSpecificInfo()
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).

Returns:
a LayoutInfo sub-class instance

fillInfo

public void fillInfo(rs.sol.soloist.client.common.info.layout.LayoutInfo info)
Fills-in already created LayoutInfo object with values of properties of this object.

Parameters:
info - a LayoutInfo sub-class object to be filled-in
See Also:
createSpecificInfo()