Module org.icepdf.ri.viewer

Package org.icepdf.ri.common.views.annotations

Class FreeTextAnnotationComponent

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

org.icepdf.ri.common.views.annotations.AbstractAnnotationComponent<T>

org.icepdf.ri.common.views.annotations.MarkupAnnotationComponent<FreeTextAnnotation>

org.icepdf.ri.common.views.annotations.FreeTextAnnotationComponent

All Implemented Interfaces:

FocusListener, MouseListener, MouseMotionListener, ImageObserver, MenuContainer, PropertyChangeListener, Serializable, EventListener, DocumentListener, MouseInputListener, AnnotationComponent, ResizeableComponent

public class FreeTextAnnotationComponent
extends MarkupAnnotationComponent<FreeTextAnnotation>
implements PropertyChangeListener, DocumentListener

The FreeTextAnnotationComponent encapsulates a FreeTextAnnotation objects. It also provides basic editing functionality such as resizing, moving and change the border color and style as well as the fill color.
The Viewer RI implementation contains a FreeTextAnnotationPanel class which can edit the various properties of this component.
The FreeTextAnnotationComponent is slightly more complex then the other annotations components. Most annotations let the page pain the annotation but in this cse FreeTextAnnotationComponent paints itself by creating a JTextArea component that is made to look like the respective annotations appearance stream.

Since:

5.0

See Also:

FreeTextAnnotationPanel, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FreeTextAnnotationComponent.MyHtml2Text

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

Fields

Modifier and Type	Field	Description
protected Font	fontFile

Fields inherited from class org.icepdf.ri.common.views.annotations.MarkupAnnotationComponent

isInteractivePopupAnnotationsEnabled

Fields inherited from class org.icepdf.ri.common.views.annotations.AbstractAnnotationComponent

annotation, annotationHighlightAlpha, annotationHighlightColor, contextMenu, currentRotation, currentZoom, cursor, documentViewController, dx, dy, endOfMousePress, isEditable, isMousePressed, isMovable, isResizable, isRollover, isSelected, isShowInvisibleBorder, isSynthetic, messageBundle, pageViewComponent, previousAnnotationState, resizableBorder, resizeBoxSize, resized, startOfMousePress, startPos, wasResized

Fields inherited from class javax.swing.JComponent

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

accessibleContext, 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

Constructors

Constructor	Description
FreeTextAnnotationComponent(FreeTextAnnotation annotation, DocumentViewController documentViewController, AbstractPageViewComponent pageViewComponent)

Method Summary

Modifier and Type	Method	Description
protected void	autoResize()
void	changedUpdate(DocumentEvent e)
String	clearXMLHeader(String strXML)
void	dispose()	Dispose this component resources.
void	focusGained(FocusEvent e)
void	insertUpdate(DocumentEvent e)
boolean	isActive()
void	mouseDragged(MouseEvent me)
void	mouseMoved(MouseEvent me)
void	paintComponent(Graphics g)
void	propertyChange(PropertyChangeEvent evt)
void	removeUpdate(DocumentEvent e)
void	requestTextAreaFocus()
void	resetAppearanceShapes()	Rest the annotation appearance stream.
protected void	updatePopupText()
void	validate()

Methods inherited from class org.icepdf.ri.common.views.annotations.MarkupAnnotationComponent

buildContextMenu, contains, createPopupAnnotationComponent, getPopupAnnotationComponent, mouseClicked, togglePopupAnnotationVisibility

Methods inherited from class org.icepdf.ri.common.views.annotations.AbstractAnnotationComponent

additionalActionsHandler, convertToPageSpace, convertToPageSpace, focusLost, getAnnotation, getDocument, getPageIndex, getPageSpaceTransform, getPageViewComponent, getToPageSpaceTransform, initiateMouseMoved, isBorderStyle, isEditable, isMovable, isResizable, isRollover, isSelected, isShowInvisibleBorder, isSynthetic, limitAnnotationPosition, mouseEntered, mouseExited, mousePressed, mouseReleased, refreshAnnotationRect, refreshDirtyBounds, removeMouseListeners, resize, setBounds, setSelected, setSynthetic

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, getUI, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, 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, updateUI

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, transferFocusDownCycle, 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, getAccessibleContext, 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, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.icepdf.ri.common.views.AnnotationComponent

hasFocus, repaint

Field Detail

fontFile

protected Font fontFile

Constructor Detail

FreeTextAnnotationComponent

public FreeTextAnnotationComponent(FreeTextAnnotation annotation,
                                   DocumentViewController documentViewController,
                                   AbstractPageViewComponent pageViewComponent)

Method Detail

validate

public void validate()

Overrides:

validate in class AbstractAnnotationComponent<FreeTextAnnotation>

mouseDragged

public void mouseDragged(MouseEvent me)

Specified by:

mouseDragged in interface MouseMotionListener

Overrides:

mouseDragged in class MarkupAnnotationComponent<FreeTextAnnotation>

insertUpdate

public void insertUpdate(DocumentEvent e)

Specified by:

insertUpdate in interface DocumentListener

removeUpdate

public void removeUpdate(DocumentEvent e)

Specified by:

removeUpdate in interface DocumentListener

changedUpdate

public void changedUpdate(DocumentEvent e)

Specified by:

changedUpdate in interface DocumentListener

autoResize

protected void autoResize()

updatePopupText

protected void updatePopupText()

propertyChange

public void propertyChange(PropertyChangeEvent evt)

Specified by:

propertyChange in interface PropertyChangeListener

mouseMoved

public void mouseMoved(MouseEvent me)

Specified by:

mouseMoved in interface MouseMotionListener

Overrides:

mouseMoved in class AbstractAnnotationComponent<FreeTextAnnotation>

paintComponent

public void paintComponent(Graphics g)

Overrides:

paintComponent in class AbstractAnnotationComponent<FreeTextAnnotation>

dispose

public void dispose()

Description copied from interface: AnnotationComponent

Dispose this component resources.

Specified by:

dispose in interface AnnotationComponent

Overrides:

dispose in class AbstractAnnotationComponent<FreeTextAnnotation>

resetAppearanceShapes

public void resetAppearanceShapes()

Description copied from interface: AnnotationComponent

Rest the annotation appearance stream.

Specified by:

resetAppearanceShapes in interface AnnotationComponent

Overrides:

resetAppearanceShapes in class MarkupAnnotationComponent<FreeTextAnnotation>

isActive

public boolean isActive()

Specified by:

isActive in interface AnnotationComponent

Overrides:

isActive in class MarkupAnnotationComponent<FreeTextAnnotation>

clearXMLHeader

public String clearXMLHeader(String strXML)

focusGained

public void focusGained(FocusEvent e)

Specified by:

focusGained in interface FocusListener

Overrides:

focusGained in class AbstractAnnotationComponent<FreeTextAnnotation>

requestTextAreaFocus

public void requestTextAreaFocus()