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

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
                              rs.sol.soloist.server.guiconfiguration.components.GUISearchPanelComponent

All Implemented Interfaces:

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

public class GUISearchPanelComponent
extends GUIPanelComponent

A panel meant to be used as a container of widgets that collect serach parameter values. It should be used to provide parameters for search result widget(s) to which it should be bound using setDynamicBindingDest(List) method. When some widget (for example text box) is put into this panel, its value (search parameter) will implicitly be sent to all assigned search result widgets every time it gets modified. All search parameter widgets from this panel must have their names specified using setName(String) method. These names must character-match the the QueryBuilder's properties annotated as parameters.

In terms of layout it behaves exactly as regular panel (class GUIPanelComponent).

Author:

SOL Expert Group

Nested Class Summary

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

Field Summary

static IClass	CLASSIFIER UML class reference
IAssociationEndInstance<GUIComponent>	dynamicBindingDest Deprecated. Not for public use.
static java.lang.String	FQ_TYPE_NAME Fully qualified UML class name

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

GUISearchPanelComponent()

Method Summary

void	addDynamicBindingDest(GUIComponent c) Adds a destination widget to be bound from this panel's children.
void	clearDynamicBindingDest() Clears all destination widgets.
void	constructor() The domain-specific constructor of the Classifier.
static GUISearchPanelComponent	create(GUIContainerComponent parent, Layout layout) Returns new GUISearchPanelComponent with the given layout for its children, and assigns it to the given parent.
static GUISearchPanelComponent	create(GUIContainerComponent parent, Layout layout, LayoutData layoutData) Returns new GUISearchPanelComponent 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 GUISearchPanelComponent	createAbsolute(GUIContainerComponent parent) Returns new GUISearchPanelComponent with the absolute layout for its children, and assigns it to the given parent.
static GUISearchPanelComponent	createDock(GUIContainerComponent parent) Returns new GUISearchPanelComponent with the dock layout for its children, and assigns it to the given parent.
static GUISearchPanelComponent	createFlow(GUIContainerComponent parent) Returns new GUISearchPanelComponent with the flow layout for its children, and assigns it to the given parent.
static GUISearchPanelComponent	createHorizontal(GUIContainerComponent parent) Returns new GUISearchPanelComponent with the horizontal layout for its children, and assigns it to the given parent.
static GUISearchPanelComponent	createLayer(GUIContainerComponent parent) Returns new GUISearchPanelComponent with the layered layout for its children, and assigns it to the given parent.
static GUISearchPanelComponent	createTable(GUIContainerComponent parent) Returns new GUISearchPanelComponent with the tabular layout for its children, and assigns it to the given parent.
static GUISearchPanelComponent	createVertical(GUIContainerComponent parent) Returns new GUISearchPanelComponent with the vertical layout for its children, and assigns it to the given parent.
java.util.List<GUIComponent>	getDynamicBindingDest() Returns the collection of destination widgets to be bound from this panel's children.
void	removeDynamicBindingDest(GUIComponent c) Removes a destination widget from this panel's children.
void	setDynamicBindingDest(java.util.List<GUIComponent> components) Sets the collection of destination widgets to be bound from this panel's children.

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

createDock, createHorizontal, createTable, 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, 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

dynamicBindingDest

@Deprecated
public IAssociationEndInstance<GUIComponent> dynamicBindingDest

Deprecated. Not for public use.

Constructor Detail

GUISearchPanelComponent

public GUISearchPanelComponent()

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

create

public static GUISearchPanelComponent create(GUIContainerComponent parent,
                                             Layout layout)

Returns new GUISearchPanelComponent 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 GUISearchPanelComponent

create

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

Returns new GUISearchPanelComponent 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 GUISearchPanelComponent

createFlow

public static GUISearchPanelComponent createFlow(GUIContainerComponent parent)

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

Parameters:

parent - the parent GUIContainerComponent widget

Returns:

new GUISearchPanelComponent

createAbsolute

public static GUISearchPanelComponent createAbsolute(GUIContainerComponent parent)

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

Parameters:

parent - the parent GUIContainerComponent widget

Returns:

new GUISearchPanelComponent

createVertical

public static GUISearchPanelComponent createVertical(GUIContainerComponent parent)

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

Parameters:

parent - the parent GUIContainerComponent widget

Returns:

new GUISearchPanelComponent

createHorizontal

public static GUISearchPanelComponent createHorizontal(GUIContainerComponent parent)

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

Parameters:

parent - the parent GUIContainerComponent widget

Returns:

new GUISearchPanelComponent

createTable

public static GUISearchPanelComponent createTable(GUIContainerComponent parent)

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

Parameters:

parent - the parent GUIContainerComponent widget

Returns:

new GUISearchPanelComponent

createDock

public static GUISearchPanelComponent createDock(GUIContainerComponent parent)

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

Parameters:

parent - the parent GUIContainerComponent widget

Returns:

new GUISearchPanelComponent

createLayer

public static GUISearchPanelComponent createLayer(GUIContainerComponent parent)

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

Parameters:

parent - the parent GUIContainerComponent widget

Returns:

new GUISearchPanelComponent

getDynamicBindingDest

public java.util.List<GUIComponent> getDynamicBindingDest()

Returns the collection of destination widgets to be bound from this panel's children.

Returns:

the collection of destination widgets to be bound from this panel's children

setDynamicBindingDest

public void setDynamicBindingDest(java.util.List<GUIComponent> components)

Sets the collection of destination widgets to be bound from this panel's children.

Parameters:

components - the collection of destination widgets to be bound from this panel's children

addDynamicBindingDest

public void addDynamicBindingDest(GUIComponent c)

Adds a destination widget to be bound from this panel's children.

Parameters:

c - a destination widget to be added

removeDynamicBindingDest

public void removeDynamicBindingDest(GUIComponent c)

Removes a destination widget from this panel's children.

Parameters:

c - a destination widget to be removed

clearDynamicBindingDest

public void clearDynamicBindingDest()

Clears all destination widgets.