org.eclipse.uml2.uml
Interface Image

All Superinterfaces:
Element, EModelElement, EObject, Notifier

public interface Image
extends Element

A representation of the model object 'Image'. Physical definition of a graphical image.

The following features are supported:

See Also:
UMLPackage.getImage()

Field Summary
static String FORMAT_BMP
           
static String FORMAT_EMF
           
static String FORMAT_GIF
           
static String FORMAT_JPG
           
static String FORMAT_PNG
           
static String FORMAT_PREFIX_MIME
           
static String FORMAT_SVG
           
static String FORMAT_WMF
           
 
Method Summary
 String getContent()
          Returns the value of the 'Content' attribute
 String getFormat()
          Returns the value of the 'Format' attribute
 String getLocation()
          Returns the value of the 'Location' attribute
 boolean isSetContent()
          Returns whether the value of the 'Content' attribute is set
 boolean isSetFormat()
          Returns whether the value of the 'Format' attribute is set
 boolean isSetLocation()
          Returns whether the value of the 'Location' attribute is set
 void setContent(String value)
          Sets the value of the 'Content' attribute
 void setFormat(String value)
          Sets the value of the 'Format' attribute
 void setLocation(String value)
          Sets the value of the 'Location' attribute
 void unsetContent()
          Unsets the value of the 'Content' attribute
 void unsetFormat()
          Unsets the value of the 'Format' attribute
 void unsetLocation()
          Unsets the value of the 'Location' attribute
 
Methods inherited from interface org.eclipse.uml2.uml.Element
addKeyword, allOwnedElements, applyStereotype, createEAnnotation, createOwnedComment, destroy, getApplicableStereotype, getApplicableStereotypes, getAppliedStereotype, getAppliedStereotypes, getAppliedSubstereotype, getAppliedSubstereotypes, getKeywords, getModel, getNearestPackage, getOwnedComments, getOwnedElements, getOwner, getRelationships, getRelationships, getRequiredStereotype, getRequiredStereotypes, getSourceDirectedRelationships, getSourceDirectedRelationships, getStereotypeApplication, getStereotypeApplications, getTargetDirectedRelationships, getTargetDirectedRelationships, getValue, hasKeyword, hasValue, isStereotypeApplicable, isStereotypeApplied, isStereotypeRequired, mustBeOwned, removeKeyword, setValue, unapplyStereotype, validateHasOwner, validateNotOwnSelf
 
Methods inherited from interface org.eclipse.emf.ecore.EModelElement
getEAnnotation, getEAnnotations
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Field Detail

FORMAT_SVG

public static final String FORMAT_SVG
See Also:
Constant Field Values

FORMAT_GIF

public static final String FORMAT_GIF
See Also:
Constant Field Values

FORMAT_PNG

public static final String FORMAT_PNG
See Also:
Constant Field Values

FORMAT_JPG

public static final String FORMAT_JPG
See Also:
Constant Field Values

FORMAT_WMF

public static final String FORMAT_WMF
See Also:
Constant Field Values

FORMAT_EMF

public static final String FORMAT_EMF
See Also:
Constant Field Values

FORMAT_BMP

public static final String FORMAT_BMP
See Also:
Constant Field Values

FORMAT_PREFIX_MIME

public static final String FORMAT_PREFIX_MIME
See Also:
Constant Field Values
Method Detail

getContent

public String getContent()
Returns the value of the 'Content' attribute. This contains the serialization of the image according to the format. The value could represent a bitmap, image such as a GIF file, or drawing 'instructions' using a standard such as Scalable Vector Graphic (SVG) (which is XML based).

Returns:
the value of the 'Content' attribute.
See Also:
Image.isSetContent(), Image.unsetContent(), Image.setContent(String), UMLPackage.getImage_Content()

setContent

public void setContent(String value)
Sets the value of the 'Content' attribute.

Parameters:
value - the new value of the 'Content' attribute.
See Also:
Image.isSetContent(), Image.unsetContent(), Image.getContent()

unsetContent

public void unsetContent()
Unsets the value of the 'Content' attribute.

See Also:
Image.isSetContent(), Image.getContent(), Image.setContent(String)

isSetContent

public boolean isSetContent()
Returns whether the value of the 'Content' attribute is set.

Returns:
whether the value of the 'Content' attribute is set.
See Also:
Image.unsetContent(), Image.getContent(), Image.setContent(String)

getLocation

public String getLocation()
Returns the value of the 'Location' attribute. This contains a location that can be used by a tool to locate the image as an alternative to embedding it in the stereotype.

Returns:
the value of the 'Location' attribute.
See Also:
Image.isSetLocation(), Image.unsetLocation(), Image.setLocation(String), UMLPackage.getImage_Location()

setLocation

public void setLocation(String value)
Sets the value of the 'Location' attribute.

Parameters:
value - the new value of the 'Location' attribute.
See Also:
Image.isSetLocation(), Image.unsetLocation(), Image.getLocation()

unsetLocation

public void unsetLocation()
Unsets the value of the 'Location' attribute.

See Also:
Image.isSetLocation(), Image.getLocation(), Image.setLocation(String)

isSetLocation

public boolean isSetLocation()
Returns whether the value of the 'Location' attribute is set.

Returns:
whether the value of the 'Location' attribute is set.
See Also:
Image.unsetLocation(), Image.getLocation(), Image.setLocation(String)

getFormat

public String getFormat()
Returns the value of the 'Format' attribute. This indicates the format of the content - which is how the string content should be interpreted. The following values are reserved: SVG, GIF, PNG, JPG, WMF, EMF, BMP. In addition the prefix 'MIME: ' is also reserved. This option can be used as an alternative to express the reserved values above, for example "SVG" could instead be expressed as "MIME: image/svg+xml".

Returns:
the value of the 'Format' attribute.
See Also:
Image.isSetFormat(), Image.unsetFormat(), Image.setFormat(String), UMLPackage.getImage_Format()

setFormat

public void setFormat(String value)
Sets the value of the 'Format' attribute.

Parameters:
value - the new value of the 'Format' attribute.
See Also:
Image.isSetFormat(), Image.unsetFormat(), Image.getFormat()

unsetFormat

public void unsetFormat()
Unsets the value of the 'Format' attribute.

See Also:
Image.isSetFormat(), Image.getFormat(), Image.setFormat(String)

isSetFormat

public boolean isSetFormat()
Returns whether the value of the 'Format' attribute is set.

Returns:
whether the value of the 'Format' attribute is set.
See Also:
Image.unsetFormat(), Image.getFormat(), Image.setFormat(String)

Copyright 2003, 2006 IBM Corporation and others.
All Rights Reserved.