Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKAnnotation

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKAnnotation
All Implemented Interfaces:
java.io.Serializable

public class DKAnnotation
extends java.lang.Object
implements java.io.Serializable

This class is a wrapper of DL ANNOTATIONSTRUCT. The data structure provides information about an annotation affiliated with an object. This class will be removed, please use DKAnnotationDL.

See Also:
Serialized Form

Constructor Summary
DKAnnotation()
          Deprecated. This class will be removed, please use DKAnnotationDL
DKAnnotation(DKAnnotation aDKAnnotation)
          Deprecated. This class will be removed, please use DKAnnotationDL
 
Method Summary
 boolean equals(DKAnnotation aDKAnnotation)
          Compares this object with the parameter object.
 int getPageNumber()
          Gets the page number that this annotation object refers to.
 int getPart()
          Gets the part Id of the associated object
 short getX()
          Gets the X coordinate on the page that this annotation object refers to.
 short getY()
          Gets the Y coordinate on the page that this annotation object refers to.
 void setPageNumber(int aPageNumber)
          Sets the page number that this annotation object refers to.
 void setPart(int aPartId)
          Sets the part Id of the associated object, only positive values are valid.
 void setX(short aXcoordinate)
          Sets the X coordinate on the page that this annotation object refers to.
 void setY(short aYcoordinate)
          Sets the Y coordinate on the page that this annotation object refers to.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKAnnotation

public DKAnnotation()
Deprecated. This class will be removed, please use DKAnnotationDL

Constructs a new DKAnnotationDL object.

DKAnnotation

public DKAnnotation(DKAnnotation aDKAnnotation)
Deprecated. This class will be removed, please use DKAnnotationDL

Copy constructor.
Method Detail

setPart

public void setPart(int aPartId)
Sets the part Id of the associated object, only positive values are valid.
Parameters:
aPartId - a part Id

getPart

public int getPart()
Gets the part Id of the associated object
Returns:
the part Id

setPageNumber

public void setPageNumber(int aPageNumber)
Sets the page number that this annotation object refers to.
Parameters:
aPageNumber - a page number

getPageNumber

public int getPageNumber()
Gets the page number that this annotation object refers to.
Returns:
the page number

setX

public void setX(short aXcoordinate)
Sets the X coordinate on the page that this annotation object refers to.
Parameters:
aXcoordinate - X coordinate

getX

public short getX()
Gets the X coordinate on the page that this annotation object refers to.
Returns:
the X coordinate

setY

public void setY(short aYcoordinate)
Sets the Y coordinate on the page that this annotation object refers to.
Parameters:
aYcoordinate - Y coordinate

getY

public short getY()
Gets the Y coordinate on the page that this annotation object refers to.
Returns:
the Y coordinate

equals

public boolean equals(DKAnnotation aDKAnnotation)
Compares this object with the parameter object.
Returns:
true if both objects have the same value for each data member; otherwise return false.

EIP Java APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.