org.faceless.pdf2.viewer2.feature
Class TextSelection

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JPanel
                  extended by org.faceless.pdf2.viewer2.feature.TextSelection
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible

public abstract class TextSelection
extends JPanel

This class is a transparent panel which is laid overtop of the PagePanel. It will highlight any text in the TextSelection.RangeList returned by getRangeList(). This class is used by the TextTool and TextHighlighter classes to manage text markup, and it's unlikely that customers would need to access this class directly.

See Also:
Serialized Form

Nested Class Summary
static class TextSelection.Range
          A Range represents a selected range of PageExtractor.Text items.
static class TextSelection.RangeList
          A RangeList is a read-only list of Range objects.
 
Nested classes/interfaces inherited from class javax.swing.JPanel
JPanel.AccessibleJPanel
 
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
 
Nested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainer
 
Nested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
 
Field Summary
static int TYPE_BLOCK
          A type of highlight which will highlight the selected text using a solid block of (usually translucent) color
static int TYPE_DOUBLESTRIKEOUT
          A type of highlight which will strike-out the selected text with a double line
static int TYPE_DOUBLEUNDERLINE
          A type of highlight which will highlight the selected text using a double underline.
static int TYPE_OUTLINE
          A type of highlight which will outline the selected text.
static int TYPE_STRIKEOUT
          A type of highlight which will strike-out the selected text.
static int TYPE_UNDERLINE
          A type of highlight which will highlight the selected text using a single underline.
 
Fields inherited from class javax.swing.JComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
TextSelection(int type, Paint color, Stroke stroke, float margin)
           
 
Method Summary
 boolean contains(int x, int y)
           
 void drawHighlight(int type, Paint color, Stroke stroke, Graphics2D g, Shape shape)
          Draw a highlight of a certain type onto the specified graphics.
protected abstract  TextSelection.RangeList getRangeList()
          Return the RangeList that will be highlighted by this TextTool
 boolean isGlassPane()
          Return true if this panel should be treated as a GlassPane.
 void paintComponent(Graphics gg)
           
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TYPE_BLOCK

public static final int TYPE_BLOCK
A type of highlight which will highlight the selected text using a solid block of (usually translucent) color

See Also:
Constant Field Values

TYPE_UNDERLINE

public static final int TYPE_UNDERLINE
A type of highlight which will highlight the selected text using a single underline.

Since:
2.11.4
See Also:
Constant Field Values

TYPE_DOUBLEUNDERLINE

public static final int TYPE_DOUBLEUNDERLINE
A type of highlight which will highlight the selected text using a double underline.

Since:
2.11.4
See Also:
Constant Field Values

TYPE_OUTLINE

public static final int TYPE_OUTLINE
A type of highlight which will outline the selected text.

Since:
2.11.4
See Also:
Constant Field Values

TYPE_STRIKEOUT

public static final int TYPE_STRIKEOUT
A type of highlight which will strike-out the selected text.

Since:
2.11.4
See Also:
Constant Field Values

TYPE_DOUBLESTRIKEOUT

public static final int TYPE_DOUBLESTRIKEOUT
A type of highlight which will strike-out the selected text with a double line

Since:
2.11.4
See Also:
Constant Field Values
Constructor Detail

TextSelection

public TextSelection(int type,
                     Paint color,
                     Stroke stroke,
                     float margin)
Method Detail

isGlassPane

public boolean isGlassPane()
Return true if this panel should be treated as a GlassPane. By default this is the case, in which case the cursor will not be modified just because this panel is visible.

Since:
2.11.25

contains

public boolean contains(int x,
                        int y)
Overrides:
contains in class JComponent

getRangeList

protected abstract TextSelection.RangeList getRangeList()
Return the RangeList that will be highlighted by this TextTool


paintComponent

public void paintComponent(Graphics gg)
Overrides:
paintComponent in class JComponent

drawHighlight

public void drawHighlight(int type,
                          Paint color,
                          Stroke stroke,
                          Graphics2D g,
                          Shape shape)
Draw a highlight of a certain type onto the specified graphics.

Parameters:
type - the shape type
color - the Color
g - the Graphics Object
shape - for Outline or Block, any shape. For underline types, a GeneralPath of the form (x1,y1, x1,y2, x2,y2, x2,y1)


Copyright © 2001-2010 Big Faceless Organization