rs.sol.soloist.server.guiconfiguration.nonvisualcompoments
Class GUISlotListenerComponent

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.nonvisualcompoments.GUINonVisualComponent
                          extended by rs.sol.soloist.server.guiconfiguration.nonvisualcompoments.GUISlotListenerComponent
All Implemented Interfaces:
IElementPresentationProvider, IUpdatable, rs.sol.soloist.server.uml.concepts.IElement, IClassifierInstance, IClassInstance, IRTElement

public class GUISlotListenerComponent
extends GUINonVisualComponent

An invisible widget that accepts an object on element input pin (ipElement() method), and provides objects linked over the slot for property set by calling setPropertyFQName(String) method, on its value output pin (opValue() method). Output values will be automatically updated according to each modification of values on the slot.

Author:
SOL Expert Group

Nested Class Summary
static class GUISlotListenerComponent.FQPropertyNames
          Deprecated. Not for public use.
static class GUISlotListenerComponent.PROPERTIES
          Deprecated. Not for public use.
 
Field Summary
static IClass CLASSIFIER
          UML class reference
 IAssociationEndInstance<rs.sol.soloist.server.builtindomains.common.ElementDescriptor> element
          Deprecated. Not for public use.
static java.lang.String FQ_TYPE_NAME
          Fully qualified UML class name
 IAttributeValue<Boolean> indirect
          Deprecated. Not for public use.
 IAttributeValue<Text> propertyFQName
          Deprecated. Not for public use.
 IAttributeValue<Text> value
          Deprecated. Not for public use.
 
Fields inherited from class rs.sol.soloist.server.guiconfiguration.construction.GUIComponent
addStyle, context, description, enabled, init, inputBindings, layoutData, logger, name, outputBindings, ownerTable, parent, removeStyle, show, showInParent, styleName, tooltip, visible
 
Constructor Summary
GUISlotListenerComponent()
           
 
Method Summary
 void constructor()
          The domain-specific constructor of the Classifier.
static GUISlotListenerComponent create(GUIContainerComponent parent, IProperty property)
          Returns new GUISlotListenerComponent that reads the slot of the given property of an element received on the element input pin (ipElement()), provides just read elements on the value output pin (opValue()), and finally assigns new object to the given parent GUIContainerComponent.
 rs.sol.soloist.server.uml.concepts.IElement getElement()
          Returns the initially assigned element.
 boolean getIndirect()
          Deprecated. Not for public use.
 IProperty getProperty()
          Deprecated. Not for public use.
 java.lang.String getPropertyFQName()
          Returns the property FQ name.
 ISlot<?> ipElement()
          Returns the element input pin; when event occurs, this widget will fetch elements linked over the slot of this widget to the element from the binding message received on this pin, and provide them on the value output pin (opValue() method).
 ISlot<?> opValue()
          Returns the value output pin; when event occurs on element input pin (ipElement() method) this widget will fetch a collection of elements on the slot and provide them on this pin.
 void setElement(rs.sol.soloist.server.uml.concepts.IElement initial)
          Sets the initial element.
 void setIndirect(boolean value)
          Deprecated. Not for public use.
 void setPropertyFQName(java.lang.String fqName)
          Sets the FQ name of the property that will be used for reading corresponding slot of the element received on the element input pin (ipElement() method).
 void validate()
          Validates a configuration settings of this widget.
 
Methods inherited from class rs.sol.soloist.server.guiconfiguration.nonvisualcompoments.GUINonVisualComponent
setCellAlignment, setCellSize, setCellStyle, setCenter, setDirectionAndSize, setLeftRightWidth, setRowColumn, setRowColumn, setSize, setTopBottomHeight, setXY
 
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, setContext, setDescription, setEnabled, setLayoutData, setName, setSlot, setSlot, setStyle, setTooltip, setVisible, 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

propertyFQName

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

indirect

@Deprecated
public IAttributeValue<Boolean> indirect
Deprecated. Not for public use.

value

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


element

@Deprecated
public IAssociationEndInstance<rs.sol.soloist.server.builtindomains.common.ElementDescriptor> element
Deprecated. Not for public use.
Constructor Detail

GUISlotListenerComponent

public GUISlotListenerComponent()
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 GUINonVisualComponent

validate

public void validate()
Description copied from class: GUIComponent
Validates a configuration settings of this widget.

Overrides:
validate in class GUIComponent

getProperty

@Deprecated
public IProperty getProperty()
Deprecated. Not for public use.


getElement

public rs.sol.soloist.server.uml.concepts.IElement getElement()
Returns the initially assigned element.

Returns:
the initially assigned element
See Also:
setElement(IElement)

create

public static GUISlotListenerComponent create(GUIContainerComponent parent,
                                              IProperty property)
Returns new GUISlotListenerComponent that reads the slot of the given property of an element received on the element input pin (ipElement()), provides just read elements on the value output pin (opValue()), and finally assigns new object to the given parent GUIContainerComponent.

Parameters:
parent - the parent GUIContainerComponent widget
property - the property used for transformation
Returns:
the new GUISlotListenerComponent

ipElement

public ISlot<?> ipElement()
Returns the element input pin; when event occurs, this widget will fetch elements linked over the slot of this widget to the element from the binding message received on this pin, and provide them on the value output pin (opValue() method).

Returns:
the element input pin
See Also:
setPropertyFQName(String), GUIComponentBinding

opValue

public ISlot<?> opValue()
Returns the value output pin; when event occurs on element input pin (ipElement() method) this widget will fetch a collection of elements on the slot and provide them on this pin.

Returns:
the value output pin
See Also:
GUIComponentBinding

setElement

public void setElement(rs.sol.soloist.server.uml.concepts.IElement initial)
Sets the initial element.

Parameters:
initial - the initial element

getPropertyFQName

public java.lang.String getPropertyFQName()
Returns the property FQ name.

Returns:
the property FQ name
See Also:
setPropertyFQName(String)

setPropertyFQName

public void setPropertyFQName(java.lang.String fqName)
Sets the FQ name of the property that will be used for reading corresponding slot of the element received on the element input pin (ipElement() method).

Parameters:
fqName - the property FQ name

getIndirect

@Deprecated
public boolean getIndirect()
Deprecated. Not for public use.


setIndirect

@Deprecated
public void setIndirect(boolean value)
Deprecated. Not for public use.