rs.sol.soloist.server.guiconfiguration.style
Class GUINavigatorFeature

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.style.GUISettingFeature
                      rs.sol.soloist.server.guiconfiguration.style.GUINavigatorFeature

All Implemented Interfaces:

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

Direct Known Subclasses:

GUIDefaultNavigatorFeature

public class GUINavigatorFeature
extends GUISettingFeature

A GUISettingFeature that provides a way for navigating over the object space, for specifying the elements that are rendered as subnodes of a GUI item in tree views.

Author:

SOL Expert Group

See Also:

GUIContext, GUIItemSetting

Nested Class Summary

static class	GUINavigatorFeature.FQPropertyNames Deprecated. Not for public use.
static class	GUINavigatorFeature.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
IAssociationEndInstance<GUINavigatorFeature>	next Deprecated. Not for public use.
IAssociationEndInstance<GUINavigatorFeature>	previous Deprecated. Not for public use.
IAttributeValue<Boolean>	returnsSlots Deprecated. Not for public use.
static java.lang.String	SEPARATOR Deprecated. Not for public use.
IAttributeValue<Text>	slot Deprecated. Not for public use.

Fields inherited from class rs.sol.soloist.server.guiconfiguration.style.GUISettingFeature

complain, description, name, ownerContext, ownerSetting

Constructor Summary

GUINavigatorFeature()

Method Summary

void	addToChain(GUINavigatorFeature nav) Adds the given navigator to the chain in front of this navigator (as its previous).
void	constructor() The domain-specific constructor of the Classifier.
rs.sol.soloist.client.common.info.element.SubnodesInfo	createInfo(rs.sol.soloist.server.uml.concepts.IElement el, IElementPresentationProvider epp) Deprecated. Not for public use.
static GUINavigatorFeature	createSubnodes(GUIItemSetting setting, boolean returnsSlots, IProperty... properties) Returns new GUINavigatorFeature for the given properties and assigns it to the given setting.
static GUINavigatorFeature	createSubnodes(GUIItemSetting setting, boolean returnsSlots, java.lang.String... propertyNames) Returns new GUINavigatorFeature for the given property names and assigns it to the given setting.
static GUINavigatorFeature	createSubnodes(GUIItemSetting setting, IProperty property) Returns new GUINavigatorFeature for the given property and assigns it to the given setting.
static GUINavigatorFeature	createSubnodes(GUIItemSetting setting, java.lang.String propertyName) Returns new GUINavigatorFeature for the given property name and assigns it to the given setting.
java.util.List<rs.sol.soloist.server.uml.concepts.IElement>	getElements(rs.sol.soloist.server.uml.concepts.IElement el) Deprecated. Not for public use.
java.util.List<ISlot>	getEncodedSlots(IClassifierInstance instance) Deprecated. Not for public use.
boolean	getReturnsSlots() Returns whether this navigator returns slots or not.
java.lang.String	getSlot() Returns textual representation of all properties of this navigator.
void	setReturnsSlots(boolean returnsSlots) Sets whether this navigator returns slots or not.
void	setSlot(java.lang.String slot) Sets the textual representation of all properties of this navigator.

Methods inherited from class rs.sol.soloist.server.guiconfiguration.style.GUISettingFeature

getComplain, getContext, getDescription, getName, isElementSpecific, setComplain, setDescription, setName

Methods inherited from class rs.sol.soloist.server.builtindomains.common.ObjectOfClass

handle

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, destructor, 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, destructor, 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

SEPARATOR

@Deprecated
public static java.lang.String SEPARATOR

Deprecated. Not for public use.

slot

@Deprecated
public IAttributeValue<Text> slot

Deprecated. Not for public use.

A comma-separated list of unqualified names of one or more Slots that will be returned by this Navigator.

returnsSlots

@Deprecated
public IAttributeValue<Boolean> returnsSlots

Deprecated. Not for public use.

If true, this Navigator will return a collection of Slots owned by the provided Element that must be a Classifier Instance.

The list of selected Slots is encoded in 'slot'.

Otherwise, it will return the values in the Slot encoded in 'slot'.

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

previous

@Deprecated
public IAssociationEndInstance<GUINavigatorFeature> previous

Deprecated. Not for public use.

next

@Deprecated
public IAssociationEndInstance<GUINavigatorFeature> next

Deprecated. Not for public use.

Constructor Detail

GUINavigatorFeature

public GUINavigatorFeature()

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 GUISettingFeature

addToChain

public void addToChain(GUINavigatorFeature nav)

Adds the given navigator to the chain in front of this navigator (as its previous). Links them accordingly.

Parameters:

nav - the navigator to be added

getElements

@Deprecated
public java.util.List<rs.sol.soloist.server.uml.concepts.IElement> getElements(rs.sol.soloist.server.uml.concepts.IElement el)

Deprecated. Not for public use.

Returns a collection of elements determined by this navigator (and the chain of them behind) for the given element as a node.

createInfo

@Deprecated
public rs.sol.soloist.client.common.info.element.SubnodesInfo createInfo(rs.sol.soloist.server.uml.concepts.IElement el,
                                                                                    IElementPresentationProvider epp)

Deprecated. Not for public use.

Specified by:

createInfo in class GUISettingFeature

getEncodedSlots

@Deprecated
public java.util.List<ISlot> getEncodedSlots(IClassifierInstance instance)

Deprecated. Not for public use.

createSubnodes

public static GUINavigatorFeature createSubnodes(GUIItemSetting setting,
                                                 IProperty property)

Returns new GUINavigatorFeature for the given property and assigns it to the given setting.

Parameters:

setting - the setting to which new navigator should be assigned to

property - to property of the new navigator

Returns:

new GUINavigatorFeature

createSubnodes

public static GUINavigatorFeature createSubnodes(GUIItemSetting setting,
                                                 java.lang.String propertyName)

Returns new GUINavigatorFeature for the given property name and assigns it to the given setting.

Parameters:

setting - the setting to which new navigator should be assigned to

propertyName - to property name of the new navigator

Returns:

new GUINavigatorFeature

createSubnodes

public static GUINavigatorFeature createSubnodes(GUIItemSetting setting,
                                                 boolean returnsSlots,
                                                 IProperty... properties)

Returns new GUINavigatorFeature for the given properties and assigns it to the given setting.

Parameters:

setting - the setting to which new navigator should be assigned to

returnsSlots - a boolean that tell whether this navigator should return slots

properties - a collection of properties of new navigator

Returns:

new GUINavigatorFeature

createSubnodes

public static GUINavigatorFeature createSubnodes(GUIItemSetting setting,
                                                 boolean returnsSlots,
                                                 java.lang.String... propertyNames)

Returns new GUINavigatorFeature for the given property names and assigns it to the given setting.

Parameters:

setting - the setting to which new navigator should be assigned to

returnsSlots - a boolean that tell whether this navigator should return slots

propertyNames - a collection of property names of new navigator

Returns:

new GUINavigatorFeature

getSlot

public java.lang.String getSlot()

Returns textual representation of all properties of this navigator.

Returns:

textual representation of all properties of this navigator

getReturnsSlots

public boolean getReturnsSlots()

Returns whether this navigator returns slots or not.

Returns:

whether this navigator returns slots or not

setSlot

public void setSlot(java.lang.String slot)

Sets the textual representation of all properties of this navigator.

Parameters:

slot - textual representation of all properties of this navigator

setReturnsSlots

public void setReturnsSlots(boolean returnsSlots)

Sets whether this navigator returns slots or not.

Parameters:

returnsSlots - a boolean that tells whether this navigator returns slots or not