|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWTextAnnotationDefinition
public class VWTextAnnotationDefinition
Represents a text annotation in a map. Text annotations are typically comments or similar documentation that a user can associate with one or more steps (VWMapNode objects) or routes (VWRouteDefinition objects) in a map. Associations from annotations to map nodes or routes are defined using the VWAssociationDefinition class. Text annotations can also stand alone, and do not have to be associated with map nodes or routes.
VWMapDefinition
,
VWMapNode
,
VWAssociationDefinition
,
VWTextAnnotationDefinition
,
VWRouteDefinition
,
VWAssociationDefinition.getTargetId()
,
VWAssociationDefinition.getTargetType()
,
Serialized FormMethod Summary | |
---|---|
static java.lang.String |
_get_FILE_AUTHOR()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_DATE()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_REVISION()
For FileNet internal use only, do not call. |
VWAssociationDefinition |
createAssociation(int targetId,
int targetType)
Creates, in the map that contains this annotation, an assocation from this text annotation to a map node (step) or route. |
void |
deleteAllAssociations()
Delete all associations from this text annotation. |
void |
deleteAssociation(int targetId,
int targetType)
Deletes a specified assocation from this text annotation. |
VWAssociationDefinition[] |
getAllAssociations()
Gets all associations from this text annotation. |
VWAssociationDefinition |
getAssociation(int targetId,
int targetType)
Gets a specified assocation from this text annotation. |
java.awt.Color |
getBgColor()
Gets the color display attributes of this annotation. |
java.awt.Dimension |
getDimension()
Gets the display dimension attribute of this annotation. |
int |
getId()
Gets the value of the id property associated with this annotation. |
java.awt.Point |
getLocation()
Gets the value of the location property associated with this annotation. |
java.lang.String |
getMessage()
Gets the value of the message property associated with this annotation. |
java.lang.String |
getName()
Gets the value of the name property associated with this annotation. |
boolean |
isMinimized()
Indicates whether this annotation is displayed as minimized. |
void |
setBgColor(java.awt.Color color)
Sets the color display attribute of this annotation. |
void |
setDimension(java.awt.Dimension dim)
Sets the display dimension attribute of this annotation. |
void |
setLocation(java.awt.Point location)
Sets the value of the location property associated with this annotation. |
void |
setMessage(java.lang.String message)
Sets the value of the message property associated with this annotation. |
void |
setMinimized(boolean minimized)
Enables the minimized display of this annotation. |
void |
setName(java.lang.String name)
Sets the value of the name property associated with this annotation. |
java.lang.String |
toString()
Gets the String representation of this instance. |
void |
toXML(java.lang.StringBuffer theBuffer)
Appends an XML string that represents this instance to the buffer specified by the theBuffer parameter. |
void |
toXPDL(java.lang.String indentA,
java.lang.StringBuffer theBuffer)
Appends an XPDL String that represents this instance to the buffer specified by the theBuffer parameter. |
void |
validate(java.util.Vector EDefVector)
Validates this instance, appending any validation errors found to the specified Vector. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public static java.lang.String _get_FILE_DATE()
public static java.lang.String _get_FILE_AUTHOR()
public static java.lang.String _get_FILE_REVISION()
public int getId() throws VWException
VWException
public java.awt.Point getLocation() throws VWException
VWException
public void setLocation(java.awt.Point location) throws VWException
location
- A Point object specifying the location of this annotation.
VWException
public java.lang.String getMessage() throws VWException
VWException
public void setMessage(java.lang.String message) throws VWException
message
- A String containing he message to set.
VWException
public java.lang.String getName() throws VWException
VWException
public void setName(java.lang.String name) throws VWException
name
- A String containing the name to set.
VWException
public void toXML(java.lang.StringBuffer theBuffer) throws VWException
Warning: This XML string is nonextensible, and cannot be modified in any way.
theBuffer
- A StringBuffer that will be appended with the XML content.
VWException
- Thrown if the theBuffer parameter is null.VWXMLUtil
public void toXPDL(java.lang.String indentA, java.lang.StringBuffer theBuffer) throws VWException
Warning: This XPDL String is nonextensible, and cannot be modified in any way.
indentA
- A String specifying the initial indentation for
this XPDL section.theBuffer
- A StringBuffer that will be appended with the XPDL content.
VWException
- Thrown when the theBuffer parameter is null.VWXMLUtil
public java.lang.String toString()
toString
in class java.lang.Object
public void validate(java.util.Vector EDefVector) throws VWException
EDefVector
- A Vector to which will be added a VWValidationError object for each validation
error found. This can be null; in this case, a new Vector is used.
Note: Because validate methods having EDefVector in the signature also occur on other classes, the existing Vector can contain validation errors from previous validation calls.
VWException
- Thrown if an error occurs during the validation.VWValidationError
public VWAssociationDefinition createAssociation(int targetId, int targetType) throws VWException
targetType
- An integer identifying the target type of the assocation. Valid target types are defined
in the VWAssociationTargetType
class.targetId
- An integer identifying either a step (VWMapNode) or route (VWRouteDefinition) id, depending
on the target type. The target id should be a valid id for a route or step that exists in the map containing
this annotation.
VWException
- Thrown under these conditions:
VWAssociationTargetType
,
VWMapDefinition
,
VWMapNode
,
VWAssociationDefinition
,
VWTextAnnotationDefinition
,
VWRouteDefinition
,
VWAssociationDefinition.getTargetId()
,
VWAssociationDefinition.getTargetType()
public void deleteAssociation(int targetId, int targetType) throws VWException
targetType
- An integer identifying the target type of the assocation. Use
VWAssociationDefinition.getTargetType
to get the target type.targetId
- An integer identifying the association to be deleted. Use
VWAssociationDefinition.getTargetId
to get the target id.
VWException
VWAssociationTargetType
,
VWMapDefinition
,
VWMapNode
,
VWAssociationDefinition
,
VWTextAnnotationDefinition
,
VWRouteDefinition
,
VWAssociationDefinition.getTargetId()
,
VWAssociationDefinition.getTargetType()
public void deleteAllAssociations() throws VWException
VWException
public VWAssociationDefinition[] getAllAssociations() throws VWException
VWException
VWAssociationDefinition
,
VWAssociationTargetType
public VWAssociationDefinition getAssociation(int targetId, int targetType) throws VWException
targetType
- An integer identifying the target type of the assocation. Use
VWAssociationDefinition.getTargetType
to get the target type.targetId
- An integer identifying the association. Use
VWAssociationDefinition.getTargetId
to get the target id.
VWException
- Thrown if the specified association is not found.VWAssociationTargetType
,
VWMapDefinition
,
VWMapNode
,
VWAssociationDefinition
,
VWTextAnnotationDefinition
,
VWRouteDefinition
,
VWAssociationDefinition.getTargetId()
,
VWAssociationDefinition.getTargetType()
public java.awt.Dimension getDimension()
public void setDimension(java.awt.Dimension dim)
dim
- A Dimension object for the dimension to set, or null if unused.public boolean isMinimized()
public void setMinimized(boolean minimized)
minimized
- A boolean value of true if this annotation is to be minimized; otherwise false.public java.awt.Color getBgColor()
public void setBgColor(java.awt.Color color)
color
- A Color object specifying the color attribute for this annotation, or null if unused.
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |