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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

GUIDateTimeTextFeature, GUIDefaultTextFeature, GUINumberTextFeature

public class GUITextFeature
extends GUISettingFeature

A GUISettingFeature that describes a textual representation. Defines the contents and presentation style of a text.

Author:

SOL Expert Group

See Also:

GUIContext, GUIItemSetting

Nested Class Summary

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

Field Summary

IAttributeValue<Text>	attrName Deprecated. Not for public use.
static IClass	CLASSIFIER UML class reference
static java.lang.String	FQ_TYPE_NAME Fully qualified UML class name
IAttributeValue<Boolean>	getFromType Deprecated. Not for public use.
IAttributeValue<Boolean>	isFixed Deprecated. Not for public use.
IAttributeValue<Text>	textValue Deprecated. Not for public use.

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

complain, description, name, ownerContext, ownerSetting

Constructor Summary

GUITextFeature()

Method Summary

void	constructor() The domain-specific constructor of the Classifier.
static GUITextFeature	create(GUIItemSetting setting, java.lang.String name, java.lang.String s, boolean isFixed) Deprecated. Not for public use.
static GUITextFeature	createDescription(GUIItemSetting setting, IProperty property) Returns new GUITextFeature that specifies the property from which the description of all elements affected by the specified setting will be fetched.
static GUITextFeature	createDescription(GUIItemSetting setting, java.lang.String attrName) Deprecated. Not for public use.
static GUITextFeature	createDescription(GUIItemSetting setting, java.lang.String s, boolean isFixed) Deprecated. Not for public use.
static GUITextFeature	createDescriptionFromType(GUIItemSetting setting) Deprecated. Not for public use.
static GUITextFeature	createFixedDescription(GUIItemSetting setting, java.lang.String fixedDescr) Returns new GUITextFeature that specifies fixed description for elements that are covered with specified setting.
static GUITextFeature	createFixedName(GUIItemSetting setting, java.lang.String fixedName) Returns new GUITextFeature that specifies fixed name for elements that are covered with specified setting.
static GUITextFeature	createFixedSeparator(GUIItemSetting setting, java.lang.String fixedSeparator) Returns new GUITextFeature that specifies fixed separator for elements that are covered with specified setting.
static GUITextFeature	createFixedTooltip(GUIItemSetting setting, java.lang.String fixedTooltip) Returns new GUITextFeature that specifies fixed tooltip for elements that are covered with specified setting.
static GUITextFeature	createFromType(GUIItemSetting setting, java.lang.String name) Deprecated. Not for public use.
rs.sol.soloist.client.common.info.element.TextInfo	createInfo(rs.sol.soloist.server.uml.concepts.IElement el, IElementPresentationProvider epp) Deprecated. Not for public use.
static GUITextFeature	createName(GUIItemSetting setting, IProperty property) Returns new GUITextFeature that specifies the property from which the name of all elements affected by the specified setting will be fetched.
static GUITextFeature	createName(GUIItemSetting setting, java.lang.String attrName) Deprecated. Not for public use.
static GUITextFeature	createName(GUIItemSetting setting, java.lang.String s, boolean isFixed) Deprecated. Not for public use.
static GUITextFeature	createNameFromType(GUIItemSetting setting) Deprecated. Not for public use.
static GUITextFeature	createSeparator(GUIItemSetting setting, IProperty property) Returns new GUITextFeature that specifies the property from which the separator of all elements affected by the specified setting will be fetched.
static GUITextFeature	createSeparator(GUIItemSetting setting, java.lang.String attrName) Deprecated. Not for public use.
static GUITextFeature	createSeparator(GUIItemSetting setting, java.lang.String s, boolean isFixed) Deprecated. Not for public use.
static GUITextFeature	createSeparatorFromType(GUIItemSetting setting) Deprecated. Not for public use.
static GUITextFeature	createTooltip(GUIItemSetting setting, IProperty property) Returns new GUITextFeature that specifies the property from which the tooltip of all elements affected by the specified setting will be fetched.
static GUITextFeature	createTooltip(GUIItemSetting setting, java.lang.String s, boolean isFixed) Deprecated. Not for public use.
static GUITextFeature	createTooltipFromType(GUIItemSetting setting) Deprecated. Not for public use.
java.lang.String	getAttributeName() Returns the attribute name of this feature.
boolean	getFixed() Returns whether this feature specifies fixed text.
java.lang.String	getFromType(IClassifierInstance instance) Deprecated. Not for public use.
boolean	getGetFromType() Deprecated.
java.lang.String	getText(IDataTypeInstance value) Returns the textual value (the contents) defined by this feature for the given data type instance.
java.lang.String	getTextValue() Returns the fixed text of this feature.
java.lang.String	getValue(rs.sol.soloist.server.uml.concepts.IElement el) Returns the textual value (the contents) defined by this feature for the given element.
boolean	isElementSpecific() Deprecated. Not for public use.
static boolean	isValidSlot(ISlot slot) Deprecated. Not for public use.
void	setAttributeName(java.lang.String attributeName) Sets the attribute name for this feature.
void	setFixed(boolean fixed) Sets whether this feature is fixed or not.
void	setGetFromType(boolean getFromType) Deprecated.
void	setTextValue(java.lang.String textValue) Sets fixed text value for this feature.

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

getComplain, getContext, getDescription, getName, 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

isFixed

@Deprecated
public IAttributeValue<Boolean> isFixed

Deprecated. Not for public use.

Is the contents defined as a fixed value?

getFromType

@Deprecated
public IAttributeValue<Boolean> getFromType

Deprecated. Not for public use.

Is the contents defined as the name of the type of the Element?

textValue

@Deprecated
public IAttributeValue<Text> textValue

Deprecated. Not for public use.

If the contents is a fixed value, this attribute defines that value.

attrName

@Deprecated
public IAttributeValue<Text> attrName

Deprecated. Not for public use.

If the contents is a obtained from an Attribute Value, this attribute defines that unqualified or qualified name of that Attribute.

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

Constructor Detail

GUITextFeature

public GUITextFeature()

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

getValue

public java.lang.String getValue(rs.sol.soloist.server.uml.concepts.IElement el)

Returns the textual value (the contents) defined by this feature for the given element.

Parameters:

el - the element whose text should be retrieved

Returns:

the textual representation of the specified element

isElementSpecific

@Deprecated
public boolean isElementSpecific()

Deprecated. Not for public use.

Overrides:

isElementSpecific in class GUISettingFeature

isValidSlot

@Deprecated
public static boolean isValidSlot(ISlot slot)

Deprecated. Not for public use.

getFromType

@Deprecated
public java.lang.String getFromType(IClassifierInstance instance)

Deprecated. Not for public use.

getText

public java.lang.String getText(IDataTypeInstance value)

Returns the textual value (the contents) defined by this feature for the given data type instance.

Parameters:

value - the element whose text should be retrieved

Returns:

the textual representation of the specified data type instance

createInfo

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

Deprecated. Not for public use.

Specified by:

createInfo in class GUISettingFeature

createFixedName

public static GUITextFeature createFixedName(GUIItemSetting setting,
                                             java.lang.String fixedName)

Returns new GUITextFeature that specifies fixed name for elements that are covered with specified setting.

Parameters:

setting - the setting whose elements are affected by new feature

fixedName - the fixed name that will hold for all elements of the owner setting

Returns:

new GUITextFeature

createFixedDescription

public static GUITextFeature createFixedDescription(GUIItemSetting setting,
                                                    java.lang.String fixedDescr)

Returns new GUITextFeature that specifies fixed description for elements that are covered with specified setting.

Parameters:

setting - the setting whose elements are affected by new feature

fixedDescr - the fixed description that will hold for all elements of the owner setting

Returns:

new GUITextFeature

createFixedTooltip

public static GUITextFeature createFixedTooltip(GUIItemSetting setting,
                                                java.lang.String fixedTooltip)

Returns new GUITextFeature that specifies fixed tooltip for elements that are covered with specified setting.

Parameters:

setting - the setting whose elements are affected by new feature

fixedTooltip - the fixed tooltip that will hold for all elements of the owner setting

Returns:

new GUITextFeature

createFixedSeparator

public static GUITextFeature createFixedSeparator(GUIItemSetting setting,
                                                  java.lang.String fixedSeparator)

Returns new GUITextFeature that specifies fixed separator for elements that are covered with specified setting.

Parameters:

setting - the setting whose elements are affected by new feature

fixedSeparator - the fixed separator that will hold for all elements of the owner setting

Returns:

new GUITextFeature

createName

public static GUITextFeature createName(GUIItemSetting setting,
                                        IProperty property)

Returns new GUITextFeature that specifies the property from which the name of all elements affected by the specified setting will be fetched.

Parameters:

setting - the setting whose elements are affected by new feature

property - the property whose slot will be read to fetch the name

Returns:

new GUITextFeature

createSeparator

public static GUITextFeature createSeparator(GUIItemSetting setting,
                                             IProperty property)

Returns new GUITextFeature that specifies the property from which the separator of all elements affected by the specified setting will be fetched.

Parameters:

setting - the setting whose elements are affected by new feature

property - the property whose slot will be read to fetch the separator

Returns:

new GUITextFeature

createDescription

public static GUITextFeature createDescription(GUIItemSetting setting,
                                               IProperty property)

Returns new GUITextFeature that specifies the property from which the description of all elements affected by the specified setting will be fetched.

Parameters:

setting - the setting whose elements are affected by new feature

property - the property whose slot will be read to fetch the description

Returns:

new GUITextFeature

createTooltip

public static GUITextFeature createTooltip(GUIItemSetting setting,
                                           IProperty property)

Returns new GUITextFeature that specifies the property from which the tooltip of all elements affected by the specified setting will be fetched.

Parameters:

setting - the setting whose elements are affected by new feature

property - the property whose slot will be read to fetch the tooltip

Returns:

new GUITextFeature

getTextValue

public java.lang.String getTextValue()

Returns the fixed text of this feature.

Returns:

the fixed text of this feature

getAttributeName

public java.lang.String getAttributeName()

Returns the attribute name of this feature.

Returns:

the attribute name of this feature

getFixed

public boolean getFixed()

Returns whether this feature specifies fixed text.

Returns:

whether this feature specifies fixed text

setTextValue

public void setTextValue(java.lang.String textValue)

Sets fixed text value for this feature.

Parameters:

textValue - new fixed value

setAttributeName

public void setAttributeName(java.lang.String attributeName)

Sets the attribute name for this feature.

Parameters:

attributeName - an attribute name

setFixed

public void setFixed(boolean fixed)

Sets whether this feature is fixed or not.

Parameters:

fixed - the boolean that tells whether this feature is fixed or not

getGetFromType

@Deprecated
public boolean getGetFromType()

Deprecated.

setGetFromType

@Deprecated
public void setGetFromType(boolean getFromType)

Deprecated.

createName

@Deprecated
public static GUITextFeature createName(GUIItemSetting setting,
                                                   java.lang.String attrName)

Deprecated. Not for public use.

createSeparator

@Deprecated
public static GUITextFeature createSeparator(GUIItemSetting setting,
                                                        java.lang.String attrName)

Deprecated. Not for public use.

createDescription

@Deprecated
public static GUITextFeature createDescription(GUIItemSetting setting,
                                                          java.lang.String attrName)

Deprecated. Not for public use.

createName

@Deprecated
public static GUITextFeature createName(GUIItemSetting setting,
                                                   java.lang.String s,
                                                   boolean isFixed)

Deprecated. Not for public use.

createSeparator

@Deprecated
public static GUITextFeature createSeparator(GUIItemSetting setting,
                                                        java.lang.String s,
                                                        boolean isFixed)

Deprecated. Not for public use.

createDescription

@Deprecated
public static GUITextFeature createDescription(GUIItemSetting setting,
                                                          java.lang.String s,
                                                          boolean isFixed)

Deprecated. Not for public use.

createTooltip

@Deprecated
public static GUITextFeature createTooltip(GUIItemSetting setting,
                                                      java.lang.String s,
                                                      boolean isFixed)

Deprecated. Not for public use.

create

@Deprecated
public static GUITextFeature create(GUIItemSetting setting,
                                               java.lang.String name,
                                               java.lang.String s,
                                               boolean isFixed)

Deprecated. Not for public use.

createFromType

@Deprecated
public static GUITextFeature createFromType(GUIItemSetting setting,
                                                       java.lang.String name)

Deprecated. Not for public use.

createNameFromType

@Deprecated
public static GUITextFeature createNameFromType(GUIItemSetting setting)

Deprecated. Not for public use.

createSeparatorFromType

@Deprecated
public static GUITextFeature createSeparatorFromType(GUIItemSetting setting)

Deprecated. Not for public use.

createDescriptionFromType

@Deprecated
public static GUITextFeature createDescriptionFromType(GUIItemSetting setting)

Deprecated. Not for public use.

createTooltipFromType

@Deprecated
public static GUITextFeature createTooltipFromType(GUIItemSetting setting)

Deprecated. Not for public use.