public interface Comment extends PropertiedObject
Modifier and Type | Method and Description |
---|---|
void |
addAssociatedIDs(java.util.List<java.lang.String> nodeIds)
Adds the supplied node IDs to the set of associated nodes.
|
java.util.List<java.lang.String> |
getAssociatedIDs()
Returns the list of node IDs that this comment is associated with.
|
java.lang.String |
getBGColor()
Returns the background color as a string of the form "#rrggbb".
|
java.lang.String |
getFGColor()
Returns the foreground color as a string of the form "#rrggbb".
|
int |
getHeight()
Returns the height of the comment in pixels.
|
java.lang.String |
getID()
Returns the ID of this object.
|
ProcessorDiagram |
getProcessorDiagram()
Returns the
ProcessorDiagram that owns this comment. |
java.lang.String |
getText()
Returns the comment text.
|
int |
getWidth()
Returns the width of the comment in pixels.
|
int |
getXPosition()
Returns the x position offset of the comment in the
ProcessorDiagram . |
int |
getYPosition()
Returns the y position offset of the comment in the
ProcessorDiagram . |
boolean |
isAnnotation()
Returns
true if this comment is displaying the annotation of the diagram
or stream. |
boolean |
isAssociated(java.lang.String nodeId)
Returns
true if this comment is associated with the specified node ID. |
boolean |
isUseCustomColors()
Returns
true if the comment is using custom colors i.e. |
void |
removeAssociatedIDs(java.util.List<java.lang.String> nodeIds)
Removed the supplied node IDs from the set of associated nodes.
|
void |
setBGColor(java.lang.String rgb)
Sets the background color using a string of the form "#rrggbb".
|
void |
setFGColor(java.lang.String rgb)
Sets the foreground color using a string of the form "#rrggbb".
|
void |
setSize(int width,
int height)
Sets the size of the comment.
|
void |
setText(java.lang.String text)
Sets the comment text.
|
void |
setUseCustomColors(boolean value)
Sets whether the comment is using custom colors i.e. those defined by the
properties
background_color and foreground_color . |
void |
setXYPosition(int x,
int y)
Sets the position of the comment in the
ProcessorDiagram . |
clearKeyedProperty, creationDate, getKeyedPropertyKeys, getKeyedPropertyValue, getLabel, getName, getPropertyType, getPropertyValue, getSavedByVersion, getStructuredPropertyDefinition, isKeyedProperty, isLocked, isProperty, isServerConnectionRequiredProperty, propertyIterator, setKeyedPropertyValue, setLabel, setPropertyValue, setPropertyValues, setPropertyValuesFrom, unlock
java.lang.String getID()
ProcessorDiagram getProcessorDiagram()
ProcessorDiagram
that owns this comment.ProcessorDiagram
that owns this commentjava.lang.String getText()
void setText(java.lang.String text)
text
- the comment textint getXPosition()
ProcessorDiagram
.int getYPosition()
ProcessorDiagram
.void setXYPosition(int x, int y)
ProcessorDiagram
.x
- the x offsety
- the y offsetint getWidth()
int getHeight()
void setSize(int width, int height)
width
- the width in pixelsheight
- the height in pixelsboolean isUseCustomColors()
true
if the comment is using custom colors i.e.
those defined by the properties background_color
and foreground_color
.true
if the comment is using custom colorsvoid setUseCustomColors(boolean value)
background_color
and foreground_color
.value
- whether to use custom colorsjava.lang.String getFGColor()
setFGColor(String)
void setFGColor(java.lang.String rgb)
rgb
- a string of the form "#rrggbb"getFGColor()
,
setUseCustomColors(boolean)
java.lang.String getBGColor()
void setBGColor(java.lang.String rgb)
rgb
- a string of the form "#rrggbb"getBGColor()
,
setUseCustomColors(boolean)
boolean isAnnotation()
true
if this comment is displaying the annotation of the diagram
or stream.true
if this comment is displaying the annotation of the diagram
or streamjava.util.List<java.lang.String> getAssociatedIDs()
boolean isAssociated(java.lang.String nodeId)
true
if this comment is associated with the specified node ID.nodeId
- the node IDtrue
if this comment is associated with the specified node IDvoid addAssociatedIDs(java.util.List<java.lang.String> nodeIds)
nodeIds
- the node IDs to be addedvoid removeAssociatedIDs(java.util.List<java.lang.String> nodeIds)
nodeIds
- the node IDs to be removed(C) Copyright IBM Corp. 1994, 2015. All Rights Reserved.