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

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

public class GUISlotSetting
extends GUIItemSetting

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

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

Nested Class Summary
static class GUISlotSetting.FQPropertyNames
          Deprecated. Not for public use.
static class GUISlotSetting.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
 IAttributeValue<PropertyKind> kind
          Deprecated. Not for public use.
 IAssociationEndInstance<rs.sol.soloist.server.builtindomains.common.ElementDescriptor> specificElement
          Deprecated.  
 
Fields inherited from class rs.sol.soloist.server.guiconfiguration.style.GUIItemSetting
description, features, name, owner, ownerFeature, subsettings, supersetting
 
Constructor Summary
GUISlotSetting()
           
 
Method Summary
 void constructor()
          The domain-specific constructor of the Classifier.
static GUISlotSetting create(GUIContext context, rs.sol.soloist.server.uml.concepts.IElement specificElement)
          Returns new GUISlotSetting for the given element and assigns it to the given context.
 PropertyKind getKind()
          Returns whether this setting is related to attribute or association end.
 int getMatchingRate(rs.sol.soloist.server.uml.concepts.IElement el)
          Deprecated.  
 rs.sol.soloist.server.uml.concepts.IElement getSpecificElement()
          Returns the specific element that this setting holds for.
 void setKind(PropertyKind kind)
          Sets whether this setting is related to attribute or association end.
 
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

kind

@Deprecated
public IAttributeValue<PropertyKind> kind
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


specificElement

@Deprecated
public IAssociationEndInstance<rs.sol.soloist.server.builtindomains.common.ElementDescriptor> specificElement
Deprecated. 
Constructor Detail

GUISlotSetting

public GUISlotSetting()
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. 

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).

Redefined. Does:

- If el is not a Slot, then return -1;

- Else if (specificElement!=null and specificElement is a SlotDescriptor), then if (el==specificElement.getElement()) then return 0;

- Else if (specificElement!=null and specificElement is a PropertyDescriptor), then if (el.getProperty()==specificElement.getElement()) then return 1;

- Else if (specificElement!=null and specificElement is a ClassDescriptor), then if (el.getProperty().getClassifier()==specificElement.getElement()) then return 2;

- Else if (specificElement==null), then return 3;

- Else return -1.

Specified by:
getMatchingRate in class GUIItemSetting

getSpecificElement

public rs.sol.soloist.server.uml.concepts.IElement getSpecificElement()
Returns the specific element that this setting holds for.

Returns:
the specific element that this setting holds for

create

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

Parameters:
context - the context to which new setting should be assigned to
specificElement - the specific element new setting holds for
Returns:
new GUISlotSetting

setKind

public void setKind(PropertyKind kind)
Sets whether this setting is related to attribute or association end.

Parameters:
kind - the property kind that tell whether this setting is related to attribute or association end

getKind

public PropertyKind getKind()
Returns whether this setting is related to attribute or association end.

Returns:
whether this setting is related to attribute or association end