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

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.GUIIndexOfElement
All Implemented Interfaces:
IElementPresentationProvider, IUpdatable, rs.sol.soloist.server.uml.concepts.IElement, IClassifierInstance, IClassInstance, IRTElement

public class GUIIndexOfElement
extends GUINonVisualComponent

An invisible widget that puts the index of the element provided on the element input pin (ipElement() method) in the collection provided on the input input pin (ipInput()), to the output output pin (opOutput() method).

Author:
SOL Expert Group

Nested Class Summary
static class GUIIndexOfElement.FQPropertyNames
          Deprecated. Not for public use.
static class GUIIndexOfElement.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
 IAttributeValue<Text> input
          Deprecated. Not for public use.
 IAttributeValue<Text> output
          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
GUIIndexOfElement()
           
 
Method Summary
 void constructor()
          The domain-specific constructor of the Classifier.
static GUIIndexOfElement create(GUIContainerComponent parent)
          Returns new GUIIndexOfElement and assigns it to its parent widget.
static GUIIndexOfElement create(GUIContainerComponent parent, ISlot pinInput, ISlot pinElement)
          Deprecated. Not for public use.
 ISlot<?> ipElement()
          Returns the element input pin; when event occurs, the element from the binding message will be used to determine its index (position) in a collection obtained through the other input pin input (ipInput() method), and to provide that found index on the output output pin (opOutput() method).
 ISlot<?> ipInput()
          Returns the input input pin; when event occurs, the collection of values from the binding message will be inspected and the index (in a collection) that corresponds to the element obtained through the other input pin element (ipElement() method) will be provided on the output output pin (opOutput() method).
 ISlot<?> opOutput()
          Returns the output output pin; when event occurs either on input input pin (ipInput() method) or on the element input pin (ipElement() method), the index in a collection from the first pin of the element obtained from the second pin, will be provided on this pin.
 
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, validate, 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

input

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

element

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

output

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

GUIIndexOfElement

public GUIIndexOfElement()
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

create

public static GUIIndexOfElement create(GUIContainerComponent parent)
Returns new GUIIndexOfElement and assigns it to its parent widget.

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

create

@Deprecated
public static GUIIndexOfElement create(GUIContainerComponent parent,
                                                  ISlot pinInput,
                                                  ISlot pinElement)
Deprecated. Not for public use.


ipInput

public ISlot<?> ipInput()
Returns the input input pin; when event occurs, the collection of values from the binding message will be inspected and the index (in a collection) that corresponds to the element obtained through the other input pin element (ipElement() method) will be provided on the output output pin (opOutput() method).

Returns:
the input 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 to determine its index (position) in a collection obtained through the other input pin input (ipInput() method), and to provide that found index on the output output pin (opOutput() method).

Returns:
the element input pin
See Also:
GUIComponentBinding

opOutput

public ISlot<?> opOutput()
Returns the output output pin; when event occurs either on input input pin (ipInput() method) or on the element input pin (ipElement() method), the index in a collection from the first pin of the element obtained from the second pin, will be provided on this pin.

Returns:
the output output pin
See Also:
GUIComponentBinding