com.telelogic.rhapsody.core
Interface IRPGraphElement

All Known Subinterfaces:
IRPGraphEdge, IRPGraphNode

public interface IRPGraphElement


Nested Class Summary
static class IRPGraphElement.ImageLayout
          This class contains constant values for use with the method setImageLayout
 
Method Summary
 void addProperty(java.lang.String propertyKey, java.lang.String propertyType, java.lang.String propertyValue)
          method addProperty
 void applyDefaultFormat()
          method applyDefaultFormat
 IRPCollection getAllGraphicalProperties()
          method getAllGraphicalProperties
 IRPCollection getAllProperties()
          method getAllProperties
 java.lang.String getAssociatedImage()
          get associatedImage
 IRPDiagram getDiagram()
          method getDiagram
 IRPGraphElement getGraphicalParent()
          get property graphicalParent
 IRPGraphicalProperty getGraphicalProperty(java.lang.String name)
          method getGraphicalProperty
 IRPGraphicalProperty getGraphicalPropertyOfText(java.lang.String textName, java.lang.String name)
          Returns the specified graphical property for a textual element associated with the graphic element.
 java.lang.String getImageLayout()
          Returns the image layout specified for the image linked to the graphic element.
 java.lang.String getInterfaceName()
          get property interfaceName
 IRPCollection getLocalProperties()
          method getLocalProperties
 IRPModelElement getModelObject()
          get property modelObject
 java.lang.String getPropertyValue(java.lang.String propertyKey)
          method getPropertyValue
 java.lang.String getSelectedImage()
          Returns the full path of the image that was linked to the graphic element.
 void removeProperty(java.lang.String propertyKey)
          method removeProperty
 void setAssociatedImage(java.lang.String associatedImage)
          set associatedImage
 void setGraphicalProperty(java.lang.String name, java.lang.String value)
          Sets a new value for a graphical property.
 void setGraphicalPropertyOfText(java.lang.String textName, java.lang.String name, java.lang.String value)
          Sets a new value for a graphical property for the specified textual element associated with the graphic element.
 void setImageLayout(java.lang.String imageLayout)
          Used to specify the image layout that should be used for the image linked to the graphic element.
 void setPropertyValue(java.lang.String propertyKey, java.lang.String propertyValue)
          method setPropertyValue
 void setSelectedImage(java.lang.String selectedImage)
          Links the graphic element to the image represented by the path specified.
 

Method Detail

addProperty

void addProperty(java.lang.String propertyKey,
                 java.lang.String propertyType,
                 java.lang.String propertyValue)
method addProperty

Throws:
RhapsodyRuntimeException

applyDefaultFormat

void applyDefaultFormat()
method applyDefaultFormat

Throws:
RhapsodyRuntimeException

getAllGraphicalProperties

IRPCollection getAllGraphicalProperties()
method getAllGraphicalProperties

Throws:
RhapsodyRuntimeException

getAllProperties

IRPCollection getAllProperties()
method getAllProperties

Throws:
RhapsodyRuntimeException

getAssociatedImage

java.lang.String getAssociatedImage()
get associatedImage

Throws:
RhapsodyRuntimeException

getDiagram

IRPDiagram getDiagram()
method getDiagram

Throws:
RhapsodyRuntimeException

getGraphicalParent

IRPGraphElement getGraphicalParent()
get property graphicalParent

Throws:
RhapsodyRuntimeException

getGraphicalProperty

IRPGraphicalProperty getGraphicalProperty(java.lang.String name)
method getGraphicalProperty

Throws:
RhapsodyRuntimeException

getGraphicalPropertyOfText

IRPGraphicalProperty getGraphicalPropertyOfText(java.lang.String textName,
                                                java.lang.String name)
Returns the specified graphical property for a textual element associated with the graphic element. This method is intended for use with graphic elements that have more than one textual element associated with them. The textName parameter is used to indicate which of the textual elements you want the property for. The values that can be used for the textName parameter depend upon the type of graphic element, as follows: For graphic elements associated with no more than one textual element, use the method getGraphicalProperty(java.lang.String).

Parameters:
textName - the specific textual element that you want the property for
name - the name of the graphical property, for example, "TextFontName", "TextColor", "TextFontItalic", "TextFontSize", "TextFontBold"
Returns:
the graphical property that was requested

getImageLayout

java.lang.String getImageLayout()
Returns the image layout specified for the image linked to the graphic element. When using the Java version of the API, the value returned will be one of the constants defined in the class IRPGraphElement.ImageLayout. When using the COM version of the API, the value returned will be one of the following strings: "Image Only Show Name", "Image Only Without Name", "Structured", "Compartment".

Returns:
the image layout specified for the image linked to the graphic element

getInterfaceName

java.lang.String getInterfaceName()
get property interfaceName

Throws:
RhapsodyRuntimeException

getLocalProperties

IRPCollection getLocalProperties()
method getLocalProperties

Throws:
RhapsodyRuntimeException

getModelObject

IRPModelElement getModelObject()
get property modelObject

Throws:
RhapsodyRuntimeException

getPropertyValue

java.lang.String getPropertyValue(java.lang.String propertyKey)
method getPropertyValue

Throws:
RhapsodyRuntimeException

getSelectedImage

java.lang.String getSelectedImage()
Returns the full path of the image that was linked to the graphic element.

Returns:
the full path of the image linked to the graphic element

removeProperty

void removeProperty(java.lang.String propertyKey)
method removeProperty

Throws:
RhapsodyRuntimeException

setAssociatedImage

void setAssociatedImage(java.lang.String associatedImage)
set associatedImage

Throws:
RhapsodyRuntimeException

setGraphicalProperty

void setGraphicalProperty(java.lang.String name,
                          java.lang.String value)
Sets a new value for a graphical property. Certain graphical properties are available only for specific types of elements. Therefore, before including calls to this method in your code, you should call IRPGraphElement.getAllGraphicalProperties, which returns a collection of IRPGraphicalProperty objects representing the graphical properties available for the element in question. Note that for the name parameter, you only have to provide the property name, not the entire hierarchy as is the case with the method setPropertyValue.

Parameters:
name - the name of the graphical property to set
value - the value to use for the specified property

setGraphicalPropertyOfText

void setGraphicalPropertyOfText(java.lang.String textName,
                                java.lang.String name,
                                java.lang.String value)
Sets a new value for a graphical property for the specified textual element associated with the graphic element. This method is intended for use with graphic elements that have more than one textual element associated with them. The textName parameter is used to indicate which of the textual elements you want to set the property for. The values that can be used for the textName parameter depend upon the type of graphic element, as follows: Certain graphical properties are available only for specific types of elements. Therefore, before including calls to this method in your code, you should call IRPGraphElement.getAllGraphicalProperties, which returns a collection of IRPGraphicalProperty objects representing the graphical properties available for the element in question. Note that for the name parameter, you only have to provide the property name, not the entire hierarchy as is the case with the method setPropertyValue. For graphic elements associated with no more than one textual element, use the method setGraphicalProperty(java.lang.String, java.lang.String).

Parameters:
textName - the specific textual element that you want to set the property for
name - the name of the graphical property to set
value - the value to use for the specified property

setImageLayout

void setImageLayout(java.lang.String imageLayout)
Used to specify the image layout that should be used for the image linked to the graphic element. When using the Java version of the API, the value of the parameter should be one of the constants defined in the class IRPGraphElement.ImageLayout. When using the COM version of the API, the value of the parameter should be one of the following strings: "Image Only Show Name", "Image Only Without Name", "Structured", "Compartment".

Parameters:
imageLayout - the image layout that should be used for the image linked to the graphic element

setPropertyValue

void setPropertyValue(java.lang.String propertyKey,
                      java.lang.String propertyValue)
method setPropertyValue

Throws:
RhapsodyRuntimeException

setSelectedImage

void setSelectedImage(java.lang.String selectedImage)
Links the graphic element to the image represented by the path specified. To remove an existing link to an image without providing a new image, use an empty string for the parameter.

Parameters:
selectedImage - the full path to the image that should be linked to the graphic element