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

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

public class GUIPictureFeature
extends GUISettingFeature

A GUISettingFeature that describes a pictorial representation. Defines the contents and presentation style of a picture.

Author:
SOL Expert Group
See Also:
GUIContext, GUIItemSetting

Nested Class Summary
static class GUIPictureFeature.FQPropertyNames
          Deprecated. Not for public use.
static class GUIPictureFeature.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> isFixed
          Deprecated. Not for public use.
 IAttributeValue<Picture> pictureValue
          Deprecated. Not for public use.
 IAttributeValue<Text> url
          Deprecated. Not for public use.
 
Fields inherited from class rs.sol.soloist.server.guiconfiguration.style.GUISettingFeature
complain, description, name, ownerContext, ownerSetting
 
Constructor Summary
GUIPictureFeature()
           
 
Method Summary
 void constructor()
          The domain-specific constructor of the Classifier.
 rs.sol.soloist.client.common.info.element.PictureInfo createInfo(rs.sol.soloist.server.uml.concepts.IElement el, IElementPresentationProvider epp)
          Deprecated. Not for public use.
static GUIPictureFeature createSmallIcon(GUIItemSetting setting, java.lang.String s)
          Returns new GUIPictureFeature with the specified URL or attribute name and assigns it to the given setting.
 java.lang.String getAttributeName()
          Returns the picture attribute name of this feature.
 boolean getFixed()
          Returns whether this feature is related to the constant picture.
 java.io.File getPicture()
          Returns the constant picture of this feature.
 java.lang.String getURL()
          Returns the picture URL of this feature.
 Picture getValue(rs.sol.soloist.server.uml.concepts.IElement el)
          Deprecated. Not for public use.
 boolean isElementSpecific()
          Deprecated. Not for public use.
 void setAttributeName(java.lang.String attributeName)
          Sets the picture attribute name to this feature.
 void setFixed(boolean fixed)
          Set whether this feature is related to the constant picture.
 void setPicture(java.io.File pictureValue)
          Sets the constant picture of this feature.
 void setURL(java.lang.String url)
          Sets the picture URL to 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 (and provided in picVal)?


pictureValue

@Deprecated
public IAttributeValue<Picture> pictureValue
Deprecated. Not for public use.
If the contents is a fixed value, this attribute defines that value.


url

@Deprecated
public IAttributeValue<Text> url
Deprecated. Not for public use.

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

GUIPictureFeature

public GUIPictureFeature()
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

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

Returns the pictorial value (the contents) defined by this Feature for the given Element.

Does:

- If url is set throws IllegalStateException;

- If isFixed==true return picVal;

- Else if the given Element el is a ClassifierInstance, returns the value of the Attribute of el with the name attrUQName: return (IClassifierInstance)el.getSlot(attrUQName).val().


isElementSpecific

@Deprecated
public boolean isElementSpecific()
Deprecated. Not for public use.

Overrides:
isElementSpecific in class GUISettingFeature

createInfo

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

Specified by:
createInfo in class GUISettingFeature

createSmallIcon

public static GUIPictureFeature createSmallIcon(GUIItemSetting setting,
                                                java.lang.String s)
Returns new GUIPictureFeature with the specified URL or attribute name and assigns it to the given setting.

Parameters:
setting - the setting to which new feature should be assigned to
s - either an URL or an attribute name. It will be treated as a URL if it contains a dot.

getURL

public java.lang.String getURL()
Returns the picture URL of this feature.

Returns:
the picture URL of this feature

getAttributeName

public java.lang.String getAttributeName()
Returns the picture attribute name of this feature.

Returns:
the picture attribute name of this feature

getFixed

public boolean getFixed()
Returns whether this feature is related to the constant picture.

Returns:
whether this feature is related to the constant picture

getPicture

public java.io.File getPicture()
Returns the constant picture of this feature.

Returns:
the constant picture of this feature

setURL

public void setURL(java.lang.String url)
Sets the picture URL to this feature.

Parameters:
url - the picture URL of this feature

setAttributeName

public void setAttributeName(java.lang.String attributeName)
Sets the picture attribute name to this feature.

Parameters:
attributeName - the attribute name of this feature

setFixed

public void setFixed(boolean fixed)
Set whether this feature is related to the constant picture.

Parameters:
fixed - the boolean that tells whether this feature is related to the constant picture

setPicture

public void setPicture(java.io.File pictureValue)
                throws java.io.IOException
Sets the constant picture of this feature.

Parameters:
pictureValue - the file that contains the picture
Throws:
java.io.IOException