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

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.style.GUIItemSetting
                      extended by rs.sol.soloist.server.guiconfiguration.style.GUIEnumerationLiteralSetting
All Implemented Interfaces:
rs.sol.soloist.server.uml.concepts.IElement, IClassifierInstance, IClassInstance, IRTElement

public class GUIEnumerationLiteralSetting
extends GUIItemSetting

A GUIItemSetting for enumeration literals. It can configure presentation and behavior of GUI items rendering all literals, or all literals of one particular enumeration, or of one particular literal. It depends on the type of element provided during the construction of this object.

Note that this setting does not match instances of enumerations (GUIDataTypeInstanceSetting should be used instead).

Author:
SOL Expert Group
See Also:
create(GUIContext, IElement), GUIContext, GUISettingFeature

Nested Class Summary
static class GUIEnumerationLiteralSetting.FQPropertyNames
          Deprecated. Not for public use.
static class GUIEnumerationLiteralSetting.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<rs.sol.soloist.server.builtindomains.common.MElementDescriptor> specificElement
          Deprecated. Not for public use.
 
Fields inherited from class rs.sol.soloist.server.guiconfiguration.style.GUIItemSetting
description, features, name, owner, ownerFeature, subsettings, supersetting
 
Constructor Summary
GUIEnumerationLiteralSetting()
           
 
Method Summary
 void constructor()
          The domain-specific constructor of the Classifier.
static GUIEnumerationLiteralSetting create(GUIContext context, rs.sol.soloist.server.uml.concepts.IElement specificElement)
          Returns new GUIEnumerationLiteralSetting for the specified enumeration and assigns it to the specified context.
 int getMatchingRate(rs.sol.soloist.server.uml.concepts.IElement el)
          Deprecated. Not for public use.
 INamedElement getSpecificElement()
          Returns an enumeration this object holds for.
 
Methods inherited from class rs.sol.soloist.server.guiconfiguration.style.GUIItemSetting
addFeature, addSetting, clearContexts, clearFeatures, doesMatch, doesMatchFully, getDescription, getFeature, getFeatures, getName, getOwnedFeature, getSettings, removeFeature, removeSetting, 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

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


specificElement

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

GUIEnumerationLiteralSetting

public GUIEnumerationLiteralSetting()
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 GUIItemSetting

getMatchingRate

@Deprecated
public int getMatchingRate(rs.sol.soloist.server.uml.concepts.IElement el)
Deprecated. Not for public use.

Description copied from class: GUIItemSetting
Returns the measure of how this GUI Item Setting matches the given Element, i.e., the "matching distance":

== -1: does not match at all (infinite distance);

== 0: matches completely (best, 0 distance);

>0: matches partly, the greater the number - the worse it matches (longer matching distance).

Specified by:
getMatchingRate in class GUIItemSetting

getSpecificElement

public INamedElement getSpecificElement()
Returns an enumeration this object holds for.

Returns:
an enumeration this object holds for

create

public static GUIEnumerationLiteralSetting create(GUIContext context,
                                                  rs.sol.soloist.server.uml.concepts.IElement specificElement)
Returns new GUIEnumerationLiteralSetting for the specified enumeration and assigns it to the specified context.

Parameters:
context - the context to which this object should be assigned to
specificElement - the enumeration this object holds for
Returns:
GUIEnumerationLiteralSetting