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

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

All Implemented Interfaces:

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

public class GUIDisclosurePanel
extends GUIContainerComponent

A container widget that displays/hides its content depending on a clickable header. This widget strictly has one child which is typically a panel to which all other widgets must be added.

In the run-time, visiblity of the content can be also controlled by binding boolean value providing output pins to this widget's open input pin ( ipOpen() method).

The code sample that creates this widget, specifies the header, and creates its child panel is shown bellow:

 GUIDisclosurePanel disc = GUIDisclosurePanel.create(parent, "Additional details");
 GUIPanelComponent rootPanel = GUIPanelComponent.createFlow(disc);
 rootPanel.add(...);
 rootPanel.add(...);
 
 

Author:

SOL Expert Group

Nested Class Summary

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

Field Summary

IAttributeValue<Text>	appendWhenClosed Deprecated. Not for public use.
IAttributeValue<Text>	appendWhenOpen 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>	headerText Deprecated. Not for public use.
IAttributeValue<Boolean>	open 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

GUIDisclosurePanel()

Method Summary

void	constructor() The domain-specific constructor of the Classifier.
static GUIDisclosurePanel	create(GUIContainerComponent parent, java.lang.String text) Returns new GUIDisclosurePanel with the given text (label) and assigns it to the given parent.
static GUIDisclosurePanel	create(GUIContainerComponent parent, java.lang.String text, LayoutData layoutData) Returns new GUIDisclosurePanel with the given text (label), places it in the parent's layout according to the given LayoutData, and assigns it to the given parent.
rs.sol.soloist.client.common.info.DisclosurePanelInfo	createSpecificInfo() Creates and returns an empty serializable object of the appropriate ComponentInfo sub-class.
java.lang.String	getAppendWhenClose() Returns the text which is appended to the header text of this widget when the panel is closed.
java.lang.String	getAppendWhenOpen() Returns the text which is appended to the header text of this widget when the panel is opened.
java.lang.String	getHeaderText() Returns the header text (label) of this widget.
ISlot<?>	ipOpen() Returns the open input pin; when event occurs, the Boolean value from the binding message content will be used to specify whether this panel should open (true) or close (false) its sub-tree (that is, its content).
ISlot<?>	opOpen() Returns the open output pin; each time user clicks on the header of this panel and opens / closes it, the Boolean value ( true for open state, false for closed) will be provided on this pin.
void	setAppendWhenClose(java.lang.String appendWhenClosed) Sets the text which is appended to the header text of this widget when the panel is closed.
void	setAppendWhenOpen(java.lang.String appendWhenOpen) Sets the text which is appended to the header text of this widget when the panel is opened.
void	setHeaderText(java.lang.String headerText) Sets the header text (label) of this widget.
void	validate() Validates a configuration settings of this widget.

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

headerText

@Deprecated
public IAttributeValue<Text> headerText

Deprecated. Not for public use.

appendWhenOpen

@Deprecated
public IAttributeValue<Text> appendWhenOpen

Deprecated. Not for public use.

appendWhenClosed

@Deprecated
public IAttributeValue<Text> appendWhenClosed

Deprecated. Not for public use.

open

@Deprecated
public IAttributeValue<Boolean> open

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

GUIDisclosurePanel

public GUIDisclosurePanel()

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

createSpecificInfo

public rs.sol.soloist.client.common.info.DisclosurePanelInfo createSpecificInfo()

Description copied from class: GUIComponent

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

Returns:

a ComponentInfo sub-class instance

create

public static GUIDisclosurePanel create(GUIContainerComponent parent,
                                        java.lang.String text)

Returns new GUIDisclosurePanel with the given text (label) and assigns it to the given parent.

Parameters:

parent - the parent GUIContainerComponent widget

text - the panels's text or label

Returns:

new GUIDisclosurePanel

create

public static GUIDisclosurePanel create(GUIContainerComponent parent,
                                        java.lang.String text,
                                        LayoutData layoutData)

Returns new GUIDisclosurePanel with the given text (label), 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

text - the panel's text or label

layoutData - the layout data of the new panel

Returns:

new GUIDisclosurePanel

ipOpen

public ISlot<?> ipOpen()

Returns the open input pin; when event occurs, the Boolean value from the binding message content will be used to specify whether this panel should open (true) or close (false) its sub-tree (that is, its content).

Returns:

the open input pin

See Also:

GUIComponentBinding

opOpen

public ISlot<?> opOpen()

Returns the open output pin; each time user clicks on the header of this panel and opens / closes it, the Boolean value ( true for open state, false for closed) will be provided on this pin.

Returns:

the open output pin

See Also:

GUIComponentBinding

getHeaderText

public java.lang.String getHeaderText()

Returns the header text (label) of this widget.

Returns:

the header text (label) of this widget

See Also:

setHeaderText(String)

setHeaderText

public void setHeaderText(java.lang.String headerText)

Sets the header text (label) of this widget.

Parameters:

headerText - the header text (label) of this widget

getAppendWhenOpen

public java.lang.String getAppendWhenOpen()

Returns the text which is appended to the header text of this widget when the panel is opened.

Returns:

the text which is appended to the header text of this widget when the panel is opened

See Also:

setAppendWhenOpen(String)

setAppendWhenOpen

public void setAppendWhenOpen(java.lang.String appendWhenOpen)

Sets the text which is appended to the header text of this widget when the panel is opened.

Parameters:

appendWhenOpen - the text which is appended to the header text of this widget when the panel is opened

getAppendWhenClose

public java.lang.String getAppendWhenClose()

Returns the text which is appended to the header text of this widget when the panel is closed.

Returns:

the text which is appended to the header text of this widget when the panel is closed

See Also:

setAppendWhenClose(String)

setAppendWhenClose

public void setAppendWhenClose(java.lang.String appendWhenClosed)

Sets the text which is appended to the header text of this widget when the panel is closed.

Parameters:

appendWhenClosed - the text which is appended to the header text of this widget when the panel is closed