rs.sol.soloist.server.guiconfiguration.components
Class GUIPanelComponent

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.construction.GUIComponent
                      rs.sol.soloist.server.guiconfiguration.components.GUIContainerComponent
                          rs.sol.soloist.server.guiconfiguration.components.GUIPanelComponent

All Implemented Interfaces:

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

Direct Known Subclasses:

GUILazyPanel, GUISearchPanelComponent

public class GUIPanelComponent
extends GUIContainerComponent

A widget that contains and lays out its child widgets. Multiple layouts are supported: horizontal, vertical, table, flow, absolute, dock, and layer. The layout of this widget's children can be specified either in a factory method during the construction of this widget, or by calling setLayout(Layout) method.

The usage code example that specifies layout in a specific factory method is given bellow:

 GUIPanelComponent panel = GUIPanelComponent.createFlow(parent);
 
 

Or if using a general factory method:

 GUIPanelComponent panel = GUIPanelComponent.create(parent, new FlowLayout());
 
 

The third option is to create a panel step by step:

 GUIPanelComponent panel = new GUIPanelComponent();
 panel.setLayout(new FlowLayout());
 parent.add(panel);
 
 

This widget's children can be added in a simple way during construction:

 GUILabelComponent label = GUILabelComponent.create(panel, "Hello World");
 
 

or afterwards:

 GUILabelComponent label = new GUILabelComponent();
 panel.add(label);
 
 

Author:

SOL Expert Group

See Also:

Layout, LayoutData

Nested Class Summary

static class	GUIPanelComponent.FQPropertyNames Deprecated. Not for public use.
static class	GUIPanelComponent.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
IAssociationEndInstance<Layout>	layout Deprecated. Not for public use.

Fields inherited from class rs.sol.soloist.server.guiconfiguration.components.GUIContainerComponent

back, children, forward, input, logger, next, output, previous, refresh, reset, submit, visibleChild

Fields inherited from class rs.sol.soloist.server.guiconfiguration.construction.GUIComponent

addStyle, context, description, enabled, init, inputBindings, layoutData, name, outputBindings, ownerTable, parent, removeStyle, show, showInParent, styleName, tooltip, visible

Constructor Summary

GUIPanelComponent()

Method Summary

void	constructor() The domain-specific constructor of the Classifier.
static GUIPanelComponent	create(GUIContainerComponent parent, Layout layout) Returns new GUIPanelComponent with the given layout for its children, and assigns it to the given parent.
static GUIPanelComponent	create(GUIContainerComponent parent, Layout layout, LayoutData layoutData) Returns new GUIPanelComponent with the given layout for its children, places it in the parent's layout according to the given LayoutData, and assigns it to the given parent.
static GUIPanelComponent	createAbsolute(GUIContainerComponent parent) Returns new GUIPanelComponent with the absolute layout for its children, and assigns it to the given parent.
static GUIPanelComponent	createDock(GUIContainerComponent parent) Returns new GUIPanelComponent with the dock layout for its children, and assigns it to the given parent.
static GUIPanelComponent	createDock(GUIContainerComponent parent, java.lang.String units) Deprecated. Not for public use.
static GUIPanelComponent	createFlow(GUIContainerComponent parent) Returns new GUIPanelComponent with the flow layout for its children, and assigns it to the given parent.
static GUIPanelComponent	createHorizontal(GUIContainerComponent parent) Returns new GUIPanelComponent with the horizontal layout for its children, and assigns it to the given parent.
static GUIPanelComponent	createHorizontal(GUIContainerComponent parent, VerticalAlignment verticalAlignment) Returns new GUIPanelComponent with the horizontal layout and vertical alignment for its children, and assigns it to the given parent.
static GUIPanelComponent	createLayer(GUIContainerComponent parent) Returns new GUIPanelComponent with the layered layout for its children, and assigns it to the given parent.
static GUIPanelComponent	createTable(GUIContainerComponent parent) Returns new GUIPanelComponent with the tabular layout for its children, and assigns it to the given parent.
static GUIPanelComponent	createTable(GUIContainerComponent parent, java.lang.String... widths) Deprecated. Not for public use.
static GUIPanelComponent	createVertical(GUIContainerComponent parent) Returns new GUIPanelComponent with the vertical layout for its children, and assigns it to the given parent.
static GUIPanelComponent	createVertical(GUIContainerComponent parent, HorizontalAlignment horizontalAlignment) Returns new GUIPanelComponent with the vertical layout and horizontal alignment for its children, and assigns it to the given parent.
Layout	getLayout() Returns the layout for this panel.
void	setLayout(Layout l) Sets the layout for this panel.
void	validate() Validates a configuration settings of this widget.
void	validateParts(java.lang.Iterable<GUIComponent> components, java.util.Map<GUIComponent,IllegalComponentStateException> exceptions) Deprecated. Not for public use.

Methods inherited from class rs.sol.soloist.server.guiconfiguration.components.GUIContainerComponent

add, addFirst, clear, get, getVisibleChild, ipBack, ipForward, ipNext, ipPrevious, ipRefresh, ipRelay1, ipRelay2, ipReset, ipSubmit, ipVisibleChild, opRelay1, opRelay2, opVisibleChild, remove, removeFirst, setVisibleChild, validateSingleChild

Methods inherited from class rs.sol.soloist.server.guiconfiguration.construction.GUIComponent

addStyleNames, addValueToSlot, clearSlot, clone, createInfo, createInfoAlreadyValidated, destructor, fillElementInfo, getApplication, getCommands, getCommands, getCommonOwner, getContext, getDescription, getDescrString, getDragIcon, getEnabled, getFeature, getFeature, getInputBindings, getInputPin, getInputPins, getLabelString, getLargeIcon, getLayoutData, getName, getNameString, getOutputPin, getOutputPins, getOwner, getParts, getSetting, getSmallIcon, getStyle, getSubnodes, getTooltip, getTooltipString, getTypeString, getVisible, handle, ipAddStyle, ipEnabled, ipInit, ipRemoveStyle, ipShow, ipShowInParent, ipVisible, isInputPin, isOutputPin, putFeatureInfo, readElement, readElements, readSlot, readSlotAsInfo, readSubnodes, removeValueFromSlot, setCellAlignment, setCellSize, setCellStyle, setCenter, setContext, setDescription, setDirectionAndSize, setEnabled, setLayoutData, setLeftRightWidth, setName, setRowColumn, setRowColumn, setSize, setSlot, setSlot, setStyle, setTooltip, setTopBottomHeight, setVisible, setXY, toTranslateDescriptors, translatePinName, updateInfo, validateParts

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, 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, 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

layout

@Deprecated
public IAssociationEndInstance<Layout> layout

Deprecated. Not for public use.

Constructor Detail

GUIPanelComponent

public GUIPanelComponent()

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 GUIContainerComponent

validate

public void validate()

Description copied from class: GUIComponent

Validates a configuration settings of this widget.

Overrides:

validate in class GUIContainerComponent

validateParts

@Deprecated
public void validateParts(java.lang.Iterable<GUIComponent> components,
                                     java.util.Map<GUIComponent,IllegalComponentStateException> exceptions)

Deprecated. Not for public use.

Overrides:

validateParts in class GUIComponent

create

public static GUIPanelComponent create(GUIContainerComponent parent,
                                       Layout layout)

Returns new GUIPanelComponent with the given layout for its children, and assigns it to the given parent.

Parameters:

parent - the parent GUIContainerComponent widget

layout - the layout of new widget's children

Returns:

new GUIPanelComponent

create

public static GUIPanelComponent create(GUIContainerComponent parent,
                                       Layout layout,
                                       LayoutData layoutData)

Returns new GUIPanelComponent with the given layout for its children, places it in the parent's layout according to the given LayoutData, and assigns it to the given parent.

Parameters:

parent - the parent GUIContainerComponent widget

layout - the layout of new widget's children

layoutData - the layout data of the new widget

Returns:

new GUIPanelComponent

createFlow

public static GUIPanelComponent createFlow(GUIContainerComponent parent)

Returns new GUIPanelComponent with the flow layout for its children, and assigns it to the given parent.

Parameters:

parent - the parent GUIContainerComponent widget

Returns:

new GUIPanelComponent

createAbsolute

public static GUIPanelComponent createAbsolute(GUIContainerComponent parent)

Returns new GUIPanelComponent with the absolute layout for its children, and assigns it to the given parent.

Parameters:

parent - the parent GUIContainerComponent widget

Returns:

new GUIPanelComponent

createVertical

public static GUIPanelComponent createVertical(GUIContainerComponent parent)

Returns new GUIPanelComponent with the vertical layout for its children, and assigns it to the given parent.

Parameters:

parent - the parent GUIContainerComponent widget

Returns:

new GUIPanelComponent

createVertical

public static GUIPanelComponent createVertical(GUIContainerComponent parent,
                                               HorizontalAlignment horizontalAlignment)

Returns new GUIPanelComponent with the vertical layout and horizontal alignment for its children, and assigns it to the given parent.

Parameters:

parent - the parent GUIContainerComponent widget

horizontalAlignment - the horizontal alignment of the new panel's children

Returns:

new GUIPanelComponent

createHorizontal

public static GUIPanelComponent createHorizontal(GUIContainerComponent parent)

Returns new GUIPanelComponent with the horizontal layout for its children, and assigns it to the given parent.

Parameters:

parent - the parent GUIContainerComponent widget

Returns:

new GUIPanelComponent

createHorizontal

public static GUIPanelComponent createHorizontal(GUIContainerComponent parent,
                                                 VerticalAlignment verticalAlignment)

Returns new GUIPanelComponent with the horizontal layout and vertical alignment for its children, and assigns it to the given parent.

Parameters:

parent - the parent GUIContainerComponent widget

verticalAlignment - the vertical alignment of the new panel's children

Returns:

new GUIPanelComponent

createTable

public static GUIPanelComponent createTable(GUIContainerComponent parent)

Returns new GUIPanelComponent with the tabular layout for its children, and assigns it to the given parent.

Parameters:

parent - the parent GUIContainerComponent widget

Returns:

new GUIPanelComponent

createDock

public static GUIPanelComponent createDock(GUIContainerComponent parent)

Returns new GUIPanelComponent with the dock layout for its children, and assigns it to the given parent.

Parameters:

parent - the parent GUIContainerComponent widget

Returns:

new GUIPanelComponent

createLayer

public static GUIPanelComponent createLayer(GUIContainerComponent parent)

Returns new GUIPanelComponent with the layered layout for its children, and assigns it to the given parent.

Parameters:

parent - the parent GUIContainerComponent widget

Returns:

new GUIPanelComponent

setLayout

public void setLayout(Layout l)

Sets the layout for this panel.

Parameters:

l - the new layout of this panel

getLayout

public Layout getLayout()

Returns the layout for this panel.

Returns:

the layout for this panel

See Also:

setLayout(Layout)

createTable

@Deprecated
public static GUIPanelComponent createTable(GUIContainerComponent parent,
                                                       java.lang.String... widths)

Deprecated. Not for public use.

createDock

@Deprecated
public static GUIPanelComponent createDock(GUIContainerComponent parent,
                                                      java.lang.String units)

Deprecated. Not for public use.