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

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

public class GUIPropertySetting
extends GUIItemSetting

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

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

Nested Class Summary
static class GUIPropertySetting.FQPropertyNames
          Deprecated. Not for public use.
static class GUIPropertySetting.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.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
GUIPropertySetting()
           
 
Method Summary
static boolean appliesTo(PropertyKind kind, IProperty p)
          Deprecated. Not for public use.
 void constructor()
          The domain-specific constructor of the Classifier.
static GUIPropertySetting create(GUIContext context, rs.sol.soloist.server.uml.concepts.IElement el)
          Returns new GUIPropertySetting for the given element and assigns it to the given context.
 PropertyKind getKind()
          Returns whether this setting is related to atribute or an association end.
 int getMatchingRate(rs.sol.soloist.server.uml.concepts.IElement el)
          Deprecated. Not for public use.
 INamedElement getSpecificElement()
          Returns the specific element this feature holds for.
 void setKind(PropertyKind kind)
          Sets whether this setting is related to attribute or an 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.MElementDescriptor> specificElement
Deprecated. Not for public use.
Constructor Detail

GUIPropertySetting

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

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 Property, then return -1;

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

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

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

- Else return -1.

Specified by:
getMatchingRate in class GUIItemSetting

getSpecificElement

public INamedElement getSpecificElement()
Returns the specific element this feature holds for.

Returns:
the specific element this feature holds for

create

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

Parameters:
context - the context to which new setting should be assigned to
el - the element for which new setting should hold for
Returns:
new GUIPropertySetting

setKind

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

Parameters:
kind - the property kind (ASSOC_END, ATTRIBUTE)

getKind

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

Returns:
whether this setting is related to atribute or an association end

appliesTo

@Deprecated
public static boolean appliesTo(PropertyKind kind,
                                           IProperty p)
Deprecated. Not for public use.