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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

GUIMultiFileUplaod

public abstract class GUIDynamicContentsPanel
extends GUIContainerComponent

An abstract base class for a panel class with a parameterized data-dependent variable collection of child widgets. This class is meant to be sub-classed by the users by providing an implementation of the single-parameter getDynamicContents(IElement) method.

Parameter can be obtained in the run-time by binding other widget's output pin with this widget's element input pin. The implementation of the getDynamicContents(IElement) method should downcast IElement into the parameter object's direct class and based on that, return a child widgets' tree rooted in a single container widget.

Author:

SOL Expert Group

Nested Class Summary

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

Field Summary

static IClass	CLASSIFIER UML class reference
IAttributeValue<Text>	element Deprecated. Not for public use.
static java.lang.String	FQ_TYPE_NAME Fully qualified UML class name
static org.apache.log4j.Logger	logger Deprecated. Not for public use.
IAttributeValue<Text>	refreshContents Deprecated. Not for public use.

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

back, children, forward, input, 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

GUIDynamicContentsPanel()

Method Summary

void	constructor() The domain-specific constructor of the Classifier.
rs.sol.soloist.client.common.info.DynamicContentsPanelInfo	createSpecificInfo() Creates and returns an empty serializable object of the appropriate ComponentInfo sub-class.
rs.sol.soloist.client.common.info.ContainerInfo	getDynamicContents(rs.sol.soloist.client.common.descr.Descr descr) Deprecated. Not for public use.
java.lang.Object	handle(rs.sol.soloist.client.common.requests.Request request) Handles single request from the client (browser) and returns an appropriate response.
ISlot<?>	ipElement() Returns the element input pin; when event occurs, the element from the binding message will be used as a parameter to fetch a children sub-tree that should replace the existing sub-tree.
ISlot<?>	ipRefreshContents() Returns the refreshContents input pin; when event occurs, this panel will re-fetch its children sub-tree based on the last received element via the element input pin (ipElement() method).
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, 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

refreshContents

@Deprecated
public IAttributeValue<Text> refreshContents

Deprecated. Not for public use.

element

@Deprecated
public IAttributeValue<Text> element

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

logger

@Deprecated
public static final org.apache.log4j.Logger logger

Deprecated. Not for public use.

Constructor Detail

GUIDynamicContentsPanel

public GUIDynamicContentsPanel()

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

handle

public java.lang.Object handle(rs.sol.soloist.client.common.requests.Request request)

Description copied from class: GUIComponent

Handles single request from the client (browser) and returns an appropriate response. It is meant to be overriden in sub-classes.

Overrides:

handle in class GUIComponent

Parameters:

request - a Request from client deserialized and ready to be handeled

Returns:

an Object representing the server's response to a request

ipRefreshContents

public ISlot<?> ipRefreshContents()

Returns the refreshContents input pin; when event occurs, this panel will re-fetch its children sub-tree based on the last received element via the element input pin (ipElement() method).

The content of the binding message accepted on this pin is of no importance. Only event is what matters.

Returns:

the refreshContents input pin

See Also:

GUIComponentBinding

ipElement

public ISlot<?> ipElement()

Returns the element input pin; when event occurs, the element from the binding message will be used as a parameter to fetch a children sub-tree that should replace the existing sub-tree.

Returns:

the element input pin

See Also:

GUIComponentBinding

getDynamicContents

@Deprecated
public rs.sol.soloist.client.common.info.ContainerInfo getDynamicContents(rs.sol.soloist.client.common.descr.Descr descr)

Deprecated. Not for public use.