|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.sdk.common.DKAnnotationV4
Constructor Summary | |
DKAnnotationV4()
Constructs a new DKAnnotationV4 object. |
|
DKAnnotationV4(DKAnnotationV4 aDKAnnotationV4)
Copy constructor. |
|
DKAnnotationV4(int partId,
int pageNumber,
short Xcoordinate,
short Ycoordinate)
Constructs a new DKAnnotationV4 object with input parameters. |
Method Summary | |
boolean |
equals(DKAnnotationV4 aDKAnnotationV4)
Compares this object with the parameter object. |
java.lang.String |
getName()
Gets the name of this annotation 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 |
setName(java.lang.String extName)
Sets the name of this annotation object |
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 |
public DKAnnotationV4()
none
- public DKAnnotationV4(int partId, int pageNumber, short Xcoordinate, short Ycoordinate)
partId
- the part ID of the associated objectpageNumber
- the page number this annotation object refers toXcoordinate
- the x coordinate on the page that this annotation object refers toYcoordinate
- the y coordinate on the page that this annotation object refers topublic DKAnnotationV4(DKAnnotationV4 aDKAnnotationV4)
aDKAnnotationV4
- the DKAnnotationV4 object to be copied fromMethod Detail |
public java.lang.String getName() throws java.lang.Exception
getName
in interface dkExtension
java.lang.Exception
- if error detectedpublic void setName(java.lang.String extName) throws java.lang.Exception
setName
in interface dkExtension
extName
- the name of this annotation objectjava.lang.Exception
- if error detectedpublic void setPageNumber(int aPageNumber)
setPageNumber
in interface dkAnnotationExt
aPageNumber
- the page numberpublic int getPageNumber()
getPageNumber
in interface dkAnnotationExt
public void setX(short aXcoordinate)
setX
in interface dkAnnotationExt
aXcoordinate
- the X coordinatepublic short getX()
getX
in interface dkAnnotationExt
public void setY(short aYcoordinate)
setY
in interface dkAnnotationExt
aYcoordinate
- the Y coordinatepublic short getY()
getY
in interface dkAnnotationExt
public void setPart(int aPartId)
aPartId
- the part Idpublic int getPart()
public boolean equals(DKAnnotationV4 aDKAnnotationV4)
aDKAnnotationV4
- the DKAnnotationV4 object to be compared with
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |