com.qoppa.pdfViewer.panels
Interface PDFPanel

All Known Subinterfaces:

AttachmentPanel, BookmarkPanel, BookmarkPanelEditor, CommentPanel, CommentPanelNotes, LayerPanel, SignaturePanel, SignaturePanelNotes, ThumbnailPanel, ThumbnailPanelNotes

public interface PDFPanel

The panel interface for customizing the panels available in PDFViewerBean.

Author:

Qoppa Software

Field Summary

static int	ALWAYS_ACTIVE Always make the PDFPanel active when loading or modifying a document.
static int	DEFAULT_POLICY Use the default policy when loading or modifying a document to determine if a PDFPanel should be active.
static int	NEVER_ACTIVE Never make the PDFPanel active when loading or modifying a document.

Method Summary

int	getActivePolicy() Returns the policy for the PDFPanel to use when a document is loaded into the PDFViewerBean, or when a document is modified.
PanelToolbar	getToolbar() Returns a this panel's toolbar.
boolean	isActive() Returns the active state of the panel.
boolean	isPaneSelected() Returns true if this panel is currently selected; otherwise, false.
void	setActive(boolean active) Set the active state for this panel depending on the value of the parameter.
void	setActivePolicy(int policy) Sets the policy for the PDFPanel to use when a document is loaded into the PDFViewerBean, or when a document is modified.
void	setPaneVisible(boolean visible) Show or hide the this pane depending on the value of the parameter.

Field Detail

DEFAULT_POLICY

static final int DEFAULT_POLICY

Use the default policy when loading or modifying a document to determine if a PDFPanel should be active.

See Also:

Constant Field Values

ALWAYS_ACTIVE

static final int ALWAYS_ACTIVE

Always make the PDFPanel active when loading or modifying a document.

See Also:

Constant Field Values

NEVER_ACTIVE

static final int NEVER_ACTIVE

Never make the PDFPanel active when loading or modifying a document.

See Also:

Constant Field Values

Method Detail

getToolbar

PanelToolbar getToolbar()

Returns a this panel's toolbar.

Returns:

The panel toolbar

setActive

void setActive(boolean active)

Set the active state for this panel depending on the value of the parameter. When false, the panel's corresponding button on the split pane will not be visible. If this panel is currently showing, the split pane will be closed and the corresponding button will be hidden.

When true, the button will be made visible, but the button may not be showing if the split pane is not visible.

Parameters:

active - the active state

See Also:

PDFViewerBean.setSplitVisible(boolean), PDFViewerBean.setSplitPolicy(int), PDFViewerBean.setSplitOpen(boolean)

isActive

boolean isActive()

Returns the active state of the panel.

Returns:

active The active state of the panel

See Also:

setActive(boolean)

setPaneVisible

void setPaneVisible(boolean visible)

Show or hide the this pane depending on the value of the parameter.

Parameters:

visible - if true the pane will be shown; otherwise, the split pane will be closed

isPaneSelected

boolean isPaneSelected()

Returns true if this panel is currently selected; otherwise, false.

Returns:

true if this panel is currently selected; otherwise false

setActivePolicy

void setActivePolicy(int policy)

Sets the policy for the PDFPanel to use when a document is loaded into the PDFViewerBean, or when a document is modified.

• DEFAULT_POLICY: Use the document content to determine which panels should be active.
• ALWAYS_ACTIVE: Always make the panel active irrespective of the document content.
• NEVER_ACTIVE: Never make the panel active irrespective of the document content.

The value is set to DEFAULT_POLICY by default.

Parameters:

policy - the policy which should be used when loading or modifying a document

Throws:

IllegalArgumentException - if policy value isn't one of the above valid values

getActivePolicy

int getActivePolicy()

Returns the policy for the PDFPanel to use when a document is loaded into the PDFViewerBean, or when a document is modified.

Returns:

an integer indicating the onDocumentLoad policy

See Also:

setActivePolicy(int)