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

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.construction.GUIComponent
                      extended by rs.sol.soloist.server.guiconfiguration.components.GUIContainerComponent
                          extended by rs.sol.soloist.server.guiconfiguration.components.GUIPanelComponent
                              extended by rs.sol.soloist.server.guiconfiguration.components.GUILazyPanel
All Implemented Interfaces:
IElementPresentationProvider, IUpdatable, rs.sol.soloist.server.uml.concepts.IElement, IClassifierInstance, IClassInstance, IRTElement

public class GUILazyPanel
extends GUIPanelComponent

A special type of panel with additional means for content loading management. Content loading can be controlled dynamically in the run-time by binding other widgets' output pins with this widget's load and unload input pins (methods ipLoad() and ipUnload()). After the content is loaded this widget gives a signal on its loaded output pin ( opLoaded() method).

Author:
SOL Expert Group

Nested Class Summary
static class GUILazyPanel.FQPropertyNames
          Deprecated. Not for public use.
static class GUILazyPanel.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> load
          Deprecated. Not for public use.
 IAttributeValue<Text> loaded
          Deprecated. Not for public use.
 IAttributeValue<Text> unload
          Deprecated. Not for public use.
 
Fields inherited from class rs.sol.soloist.server.guiconfiguration.components.GUIPanelComponent
layout
 
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
GUILazyPanel()
           
 
Method Summary
 void constructor()
          The domain-specific constructor of the Classifier.
static GUILazyPanel create(GUIContainerComponent parent, Layout layout)
          Returns new GUILazyPanel with the given layout for its children, and assigns it to the given parent.
static GUILazyPanel create(GUIContainerComponent parent, Layout layout, LayoutData layoutData)
          Returns new GUILazyPanel 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 GUILazyPanel createAbsolute(GUIContainerComponent parent)
          Returns new GUILazyPanel with the absolute layout for its children, and assigns it to the given parent.
static GUILazyPanel createDock(GUIContainerComponent parent)
          Returns new GUILazyPanel with the dock layout for its children, and assigns it to the given parent.
static GUILazyPanel createDock(GUIContainerComponent parent, java.lang.String units)
          Deprecated. Not for public use.
static GUILazyPanel createFlow(GUIContainerComponent parent)
          Returns new GUILazyPanel with the flow layout for its children, and assigns it to the given parent.
static GUILazyPanel createHorizontal(GUIContainerComponent parent)
          Returns new GUILazyPanel with the horizontal layout for its children, and assigns it to the given parent.
static GUILazyPanel createHorizontal(GUIContainerComponent parent, VerticalAlignment verticalAlignment)
          Deprecated. Not for public use.
static GUILazyPanel createLayer(GUIContainerComponent parent)
          Returns new GUILazyPanel with the layered layout for its children, and assigns it to the given parent.
static GUILazyPanel createTable(GUIContainerComponent parent)
          Returns new GUILazyPanel with the table layout for its children, and assigns it to the given parent.
static GUILazyPanel createTable(GUIContainerComponent parent, java.lang.String... widths)
          Deprecated. Not for public use.
static GUILazyPanel createVertical(GUIContainerComponent parent)
          Returns new GUILazyPanel with the vertical layout for its children, and assigns it to the given parent.
 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<?> ipLoad()
          Returns the load input pin; when event occurs, this widget will load its content from the server.
 ISlot<?> ipUnload()
          Returns the unload input pin; when event occurs, this widget will unload its content from the server.
 ISlot<?> opLoaded()
          Returns the loaded output pin; when this widget finishes loading of its content, it signals to other interested widgets by providing an empty binding message on this pin.
 rs.sol.soloist.client.common.requests.LazyPanelResult readLazyPanel()
          Deprecated. Not for public use.
 
Methods inherited from class rs.sol.soloist.server.guiconfiguration.components.GUIPanelComponent
createVertical, getLayout, setLayout, validate, validateParts
 
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
 
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

load

@Deprecated
public IAttributeValue<Text> load
Deprecated. Not for public use.

unload

@Deprecated
public IAttributeValue<Text> unload
Deprecated. Not for public use.

loaded

@Deprecated
public IAttributeValue<Text> loaded
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

GUILazyPanel

public GUILazyPanel()
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 GUIPanelComponent

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

readLazyPanel

@Deprecated
public rs.sol.soloist.client.common.requests.LazyPanelResult readLazyPanel()
Deprecated. Not for public use.


create

public static GUILazyPanel create(GUIContainerComponent parent,
                                  Layout layout)
Returns new GUILazyPanel 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 GUILazyPanel

create

public static GUILazyPanel create(GUIContainerComponent parent,
                                  Layout layout,
                                  LayoutData layoutData)
Returns new GUILazyPanel 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 GUILazyPanel

createFlow

public static GUILazyPanel createFlow(GUIContainerComponent parent)
Returns new GUILazyPanel with the flow layout for its children, and assigns it to the given parent.

Parameters:
parent - the parent GUIContainerComponent widget
Returns:
new GUILazyPanel

createAbsolute

public static GUILazyPanel createAbsolute(GUIContainerComponent parent)
Returns new GUILazyPanel with the absolute layout for its children, and assigns it to the given parent.

Parameters:
parent - the parent GUIContainerComponent widget
Returns:
new GUILazyPanel

createVertical

public static GUILazyPanel createVertical(GUIContainerComponent parent)
Returns new GUILazyPanel with the vertical layout for its children, and assigns it to the given parent.

Parameters:
parent - the parent GUIContainerComponent widget
Returns:
new GUILazyPanel

createHorizontal

public static GUILazyPanel createHorizontal(GUIContainerComponent parent)
Returns new GUILazyPanel with the horizontal layout for its children, and assigns it to the given parent.

Parameters:
parent - the parent GUIContainerComponent widget
Returns:
new GUILazyPanel

createTable

public static GUILazyPanel createTable(GUIContainerComponent parent)
Returns new GUILazyPanel with the table layout for its children, and assigns it to the given parent.

Parameters:
parent - the parent GUIContainerComponent widget
Returns:
new GUILazyPanel

createDock

public static GUILazyPanel createDock(GUIContainerComponent parent)
Returns new GUILazyPanel with the dock layout for its children, and assigns it to the given parent.

Parameters:
parent - the parent GUIContainerComponent widget
Returns:
new GUILazyPanel

createLayer

public static GUILazyPanel createLayer(GUIContainerComponent parent)
Returns new GUILazyPanel with the layered layout for its children, and assigns it to the given parent.

Parameters:
parent - the parent GUIContainerComponent widget
Returns:
new GUILazyPanel

ipLoad

public ISlot<?> ipLoad()
Returns the load input pin; when event occurs, this widget will load its content from the server.

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

Returns:
the load input pin
See Also:
GUIComponentBinding

ipUnload

public ISlot<?> ipUnload()
Returns the unload input pin; when event occurs, this widget will unload its content from the server.

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

Returns:
the unload input pin
See Also:
GUIComponentBinding

opLoaded

public ISlot<?> opLoaded()
Returns the loaded output pin; when this widget finishes loading of its content, it signals to other interested widgets by providing an empty binding message on this pin.

Returns:
the loaded output pin
See Also:
GUIComponentBinding

createHorizontal

@Deprecated
public static GUILazyPanel createHorizontal(GUIContainerComponent parent,
                                                       VerticalAlignment verticalAlignment)
Deprecated. Not for public use.


createTable

@Deprecated
public static GUILazyPanel createTable(GUIContainerComponent parent,
                                                  java.lang.String... widths)
Deprecated. Not for public use.


createDock

@Deprecated
public static GUILazyPanel createDock(GUIContainerComponent parent,
                                                 java.lang.String units)
Deprecated. Not for public use.