|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.faceless.pdf2.viewer2.DocumentPanelEvent
public class DocumentPanelEvent
Represents an event on a DocumentPanel
indicating that document has changed
somehow. To capture these events, implement the DocumentPanelListener
interface
and register via the DocumentPanel.addDocumentPanelListener()
method.
Be sure to check the getType()
method to see what sort of event it is - current values
include:
created | Raised when the DocumentPanel is first created |
---|---|
activated | Raised when the DocumentPanel is activated with a valid PDF |
deactivated | Raised when the DocumentPanel is deactivated |
viewportChanged | Raised when the DocumentPanel has a new DocumentViewport applied to it |
loaded | Raised after a PDF is loaded |
closing | Raised when the PDF is closing |
redrawn | Raised when the PDF has been redrawn somehow |
pageChanged | Raised when the DocumentPanel changes which page is being displayed |
pagePositionChanged | Raised when the DocumentPanel changes which area of the page is being displayed |
stateChanged | Raised when the DocumentPanel's PDF has had its state changed. This event will be fired when the state of the document is updated in the current context - for instance, if the viewer validates a signature, or verifies a document against an OutputProfile . The nature of the change should be determined from the associated object. It's not for inherent changes to the document (such as when a page is removed) which result in a PropertyChangeEvent from the PDF or one of its components. |
permissionChanged | Raised when the DocumentPanel's PDF has had its permissions changed. |
This code is copyright the Big Faceless Organization. You're welcome to use, modify and distribute it in any form in your own projects, provided those projects continue to make use of the Big Faceless PDF library.
Method Summary | |
---|---|
static DocumentPanelEvent |
createActivated(DocumentPanel panel)
Create an "activated" DocumentPanelEvent |
static DocumentPanelEvent |
createClosing(DocumentPanel panel)
Create a "closing" DocumentPanelEvent |
static DocumentPanelEvent |
createCreated(DocumentPanel panel)
Create a "created" DocumentPanelEvent |
static DocumentPanelEvent |
createDeactivated(DocumentPanel panel)
Create a "deactivated" DocumentPanelEvent |
static DocumentPanelEvent |
createLoaded(DocumentPanel panel)
Create a "loaded" DocumentPanelEvent |
static DocumentPanelEvent |
createPageChanged(DocumentPanel panel)
Create a "pageChanged" DocumentPanelEvent |
static DocumentPanelEvent |
createPagePositionChanged(DocumentPanel panel)
Create a "pagePositionChanged" DocumentPanelEvent |
static DocumentPanelEvent |
createPermissionChanged(DocumentPanel panel,
String permission)
Create a "permissionChanged" DocumentPanelEvent |
static DocumentPanelEvent |
createRedrawn(DocumentPanel panel)
Create a "redrawn" DocumentPanelEvent |
static DocumentPanelEvent |
createStateChanged(DocumentPanel panel,
Object state)
Create a "stateChanged" DocumentPanelEvent |
static DocumentPanelEvent |
createViewportChanged(DocumentPanel panel)
Create a "viewportChanged" DocumentPanelEvent |
DocumentPanel |
getDocumentPanel()
Get the DocumentPanel this event was raised on |
Object |
getState()
Get the state associated with a "stateChange" events. |
String |
getType()
Get the type of the DocumentPanelEvent |
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public static DocumentPanelEvent createCreated(DocumentPanel panel)
public static DocumentPanelEvent createActivated(DocumentPanel panel)
public static DocumentPanelEvent createDeactivated(DocumentPanel panel)
public static DocumentPanelEvent createViewportChanged(DocumentPanel panel)
public static DocumentPanelEvent createPageChanged(DocumentPanel panel)
public static DocumentPanelEvent createPagePositionChanged(DocumentPanel panel)
public static DocumentPanelEvent createPermissionChanged(DocumentPanel panel, String permission)
public static DocumentPanelEvent createLoaded(DocumentPanel panel)
public static DocumentPanelEvent createClosing(DocumentPanel panel)
public static DocumentPanelEvent createRedrawn(DocumentPanel panel)
public static DocumentPanelEvent createStateChanged(DocumentPanel panel, Object state)
state
- the state that has changed.public String toString()
toString
in class Object
public DocumentPanel getDocumentPanel()
public String getType()
public Object getState()
SignatureProvider.SignatureState
will indicated a
change to the validation state of one of the docuemnt's signatures.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |