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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

GUIClassifierSetting, GUIDataTypeInstanceSetting, GUIElementSetting, GUIEnumerationLiteralSetting, GUINullSetting, GUIObjectSetting, GUIPropertySetting, GUISlotSetting

public abstract class GUIItemSetting
extends rs.sol.soloist.server.builtindomains.common.ObjectOfClass

An abstarct base class for different kinds of GUI configuration settings for specific kinds of GUI items. This object defines the presentation and behavior of elements of one kind, or for one particular element. It inherits the features from its supersetting, and can redefine some.

Author:

SOL Expert Group

See Also:

GUIContext, GUISettingFeature

Nested Class Summary

static class	GUIItemSetting.FQPropertyNames Deprecated. Not for public use.
static class	GUIItemSetting.PROPERTIES Deprecated. Not for public use.

Field Summary

static IClass	CLASSIFIER UML class reference
IAttributeValue<Text>	description Deprecated. Not for public use.
IAssociationEndInstance<GUISettingFeature>	features Deprecated. Not for public use.
static java.lang.String	FQ_TYPE_NAME Fully qualified UML class name
IAttributeValue<Text>	name Deprecated. Not for public use.
IAssociationEndInstance<GUIContext>	owner Deprecated. Not for public use.
IAssociationEndInstance<GUIMultitypingFeature>	ownerFeature Deprecated. Not for public use.
IAssociationEndInstance<GUIItemSetting>	subsettings Deprecated. Not for public use.
IAssociationEndInstance<GUIItemSetting>	supersetting Deprecated. Not for public use.

Constructor Summary

GUIItemSetting()

Method Summary

void	addFeature(GUISettingFeature f) Adds a feature to a collection of owned features.
void	addSetting(GUIItemSetting s) Adds a setting to a collection of sub-settings.
void	clearContexts() Clears all sub-settings.
void	clearFeatures() Clears all owned features.
void	constructor() The domain-specific constructor of the Classifier.
boolean	doesMatch(rs.sol.soloist.server.uml.concepts.IElement el) Deprecated.
boolean	doesMatchFully(rs.sol.soloist.server.uml.concepts.IElement el) Deprecated.
java.lang.String	getDescription() Returns the description of the setting.
GUISettingFeature	getFeature(java.lang.String name) Returns the GUISettingFeature with the given name, owned or inherited from the owner context, or null if such does not exist.
java.util.List<GUISettingFeature>	getFeatures() Returns the collection of owned features.
abstract int	getMatchingRate(rs.sol.soloist.server.uml.concepts.IElement el) Deprecated.
java.lang.String	getName() Returns the name of the setting.
GUISettingFeature	getOwnedFeature(java.lang.String name) Returns the owned GUISettingFeature with the given name or null if such does not exist.
java.util.List<GUIItemSetting>	getSettings() Returns the collection of sub-settings.
void	removeFeature(GUISettingFeature f) Removes a feature from a collection of owned features.
void	removeSetting(GUIItemSetting s) Removes a setting from a collection of sub-settings.
void	setDescription(java.lang.String desc) Sets new description for this setting.
void	setName(java.lang.String name) Sets new name for this setting.

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

name

@Deprecated
public IAttributeValue<Text> name

Deprecated. Not for public use.

The name of this object.

description

@Deprecated
public IAttributeValue<Text> description

Deprecated. Not for public use.

Arbitrary description of this object.

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

supersetting

@Deprecated
public IAssociationEndInstance<GUIItemSetting> supersetting

Deprecated. Not for public use.

subsettings

@Deprecated
public IAssociationEndInstance<GUIItemSetting> subsettings

Deprecated. Not for public use.

features

@Deprecated
public IAssociationEndInstance<GUISettingFeature> features

Deprecated. Not for public use.

owner

@Deprecated
public IAssociationEndInstance<GUIContext> owner

Deprecated. Not for public use.

ownerFeature

@Deprecated
public IAssociationEndInstance<GUIMultitypingFeature> ownerFeature

Deprecated. Not for public use.

Constructor Detail

GUIItemSetting

public GUIItemSetting()

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 rs.sol.soloist.server.builtindomains.common.ObjectOfClass

getMatchingRate

@Deprecated
public abstract 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).

doesMatch

@Deprecated
public boolean doesMatch(rs.sol.soloist.server.uml.concepts.IElement el)

Deprecated.

Does this GUI Item Setting matches the given Element at least partly?

Returns true if getMatchingRate(el)>=0.

doesMatchFully

@Deprecated
public boolean doesMatchFully(rs.sol.soloist.server.uml.concepts.IElement el)

Deprecated.

Does this GUI Item Setting fully matches the given Element?

Returns true if getMatchingRate(el)==0.

getOwnedFeature

public GUISettingFeature getOwnedFeature(java.lang.String name)

Returns the owned GUISettingFeature with the given name or null if such does not exist.

Parameters:

name - the name of the owned feature to be returned

Returns:

the owned GUISettingFeature with the given name

getFeature

public GUISettingFeature getFeature(java.lang.String name)

Returns the GUISettingFeature with the given name, owned or inherited from the owner context, or null if such does not exist.

Parameters:

name - the name of the searched for feature

Returns:

the GUISettingFeature with the given name, owned or inherited from the owner context

getName

public java.lang.String getName()

Returns the name of the setting.

Returns:

the name of the setting

getDescription

public java.lang.String getDescription()

Returns the description of the setting.

Returns:

the description of the setting

setName

public void setName(java.lang.String name)

Sets new name for this setting.

Parameters:

name - the new name of the setting

setDescription

public void setDescription(java.lang.String desc)

Sets new description for this setting.

Parameters:

desc - the new description of the setting

getSettings

public java.util.List<GUIItemSetting> getSettings()

Returns the collection of sub-settings.

Returns:

the collection of sub-settings

addSetting

public void addSetting(GUIItemSetting s)

Adds a setting to a collection of sub-settings.

Parameters:

s - the setting to be added

removeSetting

public void removeSetting(GUIItemSetting s)

Removes a setting from a collection of sub-settings.

Parameters:

s - the setting to be removed

clearContexts

public void clearContexts()

Clears all sub-settings.

getFeatures

public java.util.List<GUISettingFeature> getFeatures()

Returns the collection of owned features.

Returns:

the collection of owned features

addFeature

public void addFeature(GUISettingFeature f)

Adds a feature to a collection of owned features.

Parameters:

f - the feature to be added

removeFeature

public void removeFeature(GUISettingFeature f)

Removes a feature from a collection of owned features.

Parameters:

f - the feature to be removed

clearFeatures

public void clearFeatures()

Clears all owned features.