com.qoppa.pdfViewer
Interface IPDFPageView


public interface IPDFPageView

This interface provides access to page views on a PDF document. The interface provides methods for working with the text selection on the pages. To get an object that implements the interface, the host application can call PDFViewerBean.getPageView (int pageNumber). The method returns an object of type JComponent that is guaranteed to implement IPDFPageView.

Author:
Qoppa Software

Field Summary
static Color m_SelectFgndColor
          Deprecated. This variable cannot be changed since it is defined in an interface. Use
static Color m_SelectXORColor
          Deprecated. This variable cannot be changed since it is defined in an interface. Use
 
Method Summary
 TextSelection clearTextSelection()
          Clears the current text selection.
 TextSelection getTextSelection()
          Returns the current text selection in the page, if any.
 void setTextSelection(TextSelection ts)
          Sets the text selection in this page.
 

Field Detail

m_SelectXORColor

public static final Color m_SelectXORColor
Deprecated. This variable cannot be changed since it is defined in an interface. Use

This color is used when selecting text by making a call to Graphics2D.setXORMode (m_SelectXORColor).


m_SelectFgndColor

public static final Color m_SelectFgndColor
Deprecated. This variable cannot be changed since it is defined in an interface. Use

This color is used when selecting text by making a call to Graphics2D.setColor (m_SelectFgndColor) immediately after making a call to Graphics2D.setXORMode (m_SelectXORColor).

Method Detail

setTextSelection

public void setTextSelection(TextSelection ts)
Sets the text selection in this page.

Parameters:
ts - The new text selection.

clearTextSelection

public TextSelection clearTextSelection()
Clears the current text selection. This method has no effect if there is no text selected on the page.

Returns:
The current text selection, before being cleared.

getTextSelection

public TextSelection getTextSelection()
Returns the current text selection in the page, if any. If there is no text selected, the method returns null.

Returns:
The current text selection on the page.