|
fop 1.0 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectorg.apache.fop.render.intermediate.extensions.AbstractAction
org.apache.fop.render.intermediate.extensions.GoToXYAction
Action class which represents a "go-to" action to an absolute coordinate on a page.
| Field Summary |
| Fields inherited from interface org.apache.fop.render.intermediate.extensions.DocumentNavigationExtensionConstants |
BOOKMARK, BOOKMARK_TREE, GOTO_URI, GOTO_XY, LINK, NAMED_DESTINATION, NAMESPACE, PREFIX |
| Constructor Summary | |
GoToXYAction(java.lang.String id)
Creates a new instance with yet unknown location. |
|
GoToXYAction(java.lang.String id,
int pageIndex,
java.awt.Point targetLocation)
Creates a new instance. |
|
| Method Summary | |
int |
getPageIndex()
Returns the page index of the target page. |
java.awt.Point |
getTargetLocation()
Returns the absolute coordinates of the target location on the page. |
boolean |
isComplete()
Indicates whether the action is complete, i.e has all the required information to be rendered in the target format. |
boolean |
isSame(AbstractAction other)
Indicates whether two action are equal. Note: this is not the same as Object.equals(Object)! |
void |
setPageIndex(int pageIndex)
Sets the index of the target page. |
void |
setTargetLocation(java.awt.Point location)
Sets the absolute coordinates of the target location on the page. |
void |
toSAX(org.xml.sax.ContentHandler handler)
|
java.lang.String |
toString()
|
| Methods inherited from class org.apache.fop.render.intermediate.extensions.AbstractAction |
getID, getIDPrefix, getStructurePointer, hasID, setID, setStructurePointer |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
public GoToXYAction(java.lang.String id)
id - the identifier for this action
public GoToXYAction(java.lang.String id,
int pageIndex,
java.awt.Point targetLocation)
id - the identifier for this actionpageIndex - the index (0-based) of the target page, -1 if the page index is
still unknowntargetLocation - the absolute location on the page (coordinates in millipoints),
or null, if the position isn't known, yet| Method Detail |
public void setPageIndex(int pageIndex)
pageIndex - the index (0-based) of the target pagepublic int getPageIndex()
This function will always return a valid value for safety. Use
isComplete() to check if the link is actually complete.
public java.awt.Point getTargetLocation()
This function will always return a valid value for safety. Use
isComplete() to check if the link is actually complete.
public void setTargetLocation(java.awt.Point location)
location - the location (coordinates in millipoints)public boolean isComplete()
isComplete in class AbstractActionpublic boolean isSame(AbstractAction other)
Object.equals(Object)!
isSame in class AbstractActionother - the other action to compare to
public void toSAX(org.xml.sax.ContentHandler handler)
throws org.xml.sax.SAXException
toSAX in interface org.apache.xmlgraphics.util.XMLizableorg.xml.sax.SAXExceptionpublic java.lang.String toString()
|
fop 1.0 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||