org.faceless.pdf2.viewer2.feature
Class TextSelectionAction

java.lang.Object
  extended by org.faceless.pdf2.viewer2.ViewerFeature
      extended by org.faceless.pdf2.viewer2.feature.TextSelectionAction
Direct Known Subclasses:
MarkupSelectionAction, RedactSelectionAction, TextCopyAction

public abstract class TextSelectionAction
extends ViewerFeature

A type of feature that works with the TextTool feature. When text is selected in the TextTool and the mouse is right-clicked, the user will have the option to apply one of these actions to the selected text. Typically this is used to highlight, underline etc. text in the PDF

Since:
2.11.7

Constructor Summary
TextSelectionAction(String name)
           
 
Method Summary
abstract  String getDescription()
          Get the name of this Action, to appear in the popup menu.
abstract  void selectAction(DocumentPanel docpanel, TextSelection.RangeList ranges)
          Run the action.
 
Methods inherited from class org.faceless.pdf2.viewer2.ViewerFeature
getAllEnabledFeatures, getAllFeatures, getCustomJavaScript, getFeatureProperty, getName, initialize, isEnabledByDefault, setFeatureName, teardown, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TextSelectionAction

public TextSelectionAction(String name)
Method Detail

getDescription

public abstract String getDescription()
Get the name of this Action, to appear in the popup menu.


selectAction

public abstract void selectAction(DocumentPanel docpanel,
                                  TextSelection.RangeList ranges)
Run the action.

Parameters:
docpanel - the DocumentPanel this action is being run on.
ranges - the TextSelection.RangeList containing the list of selected text items, which may be from multiple pages


Copyright © 2001-2010 Big Faceless Organization