org.icepdf.ri.common.views
Interface AnnotationComponent

All Known Implementing Classes:
AbstractAnnotationComponent, CircleAnnotationComponent, FreeTextAnnotationComponent, InkAnnotationComponent, LineAnnotationComponent, LinkAnnotationComponent, MarkupAnnotationComponent, PolygonAnnotationComponent, PolyLineAnnotationComponent, PopupAnnotationComponent, SignatureFieldComponent, SquareAnnotationComponent, TextAnnotationComponent, TextMarkupAnnotationComponent, WidgetAnnotationComponent

public interface AnnotationComponent

AnnotationComponent interfaces. Oulines two main methods needed for management and state saving but avoids having to load the Swing/awt libraries unless necessary.

Since:
4.0

Method Summary
 void dispose()
           
 org.icepdf.core.pobjects.annotations.Annotation getAnnotation()
          Gets wrapped annotation object.
 org.icepdf.core.pobjects.Document getDocument()
           
 int getPageIndex()
           
 PageViewComponent getPageViewComponent()
           
 PageViewComponent getParentPageView()
           
 boolean hasFocus()
          Component has focus.
 boolean isBorderStyle()
          border has defined style.
 boolean isEditable()
          Component is editable, contents can be updated in ui
 boolean isMovable()
          Component is movable.
 boolean isResizable()
          Component is resizable.
 boolean isRollover()
          Component highlight/select border is draw on mouse over.
 boolean isSelected()
           
 boolean isShowInvisibleBorder()
          Component is editable, contents can be updated in ui
 void refreshAnnotationRect()
          Refreshed the annotation rectangle by inverting the components current bounds with the current page transformation.
 void refreshDirtyBounds()
          Refreshs the annotations bounds rectangle.
 void repaint()
           
 void resetAppearanceShapes()
           
 void setSelected(boolean selected)
           
 

Method Detail

getAnnotation

org.icepdf.core.pobjects.annotations.Annotation getAnnotation()
Gets wrapped annotation object.

Returns:
annotation that this component wraps.

refreshDirtyBounds

void refreshDirtyBounds()
Refreshs the annotations bounds rectangle. This method insures that the bounds have been correctly adjusted for the current page transformation In a none visual representation this method may not have to do anything.


refreshAnnotationRect

void refreshAnnotationRect()
Refreshed the annotation rectangle by inverting the components current bounds with the current page transformation.


hasFocus

boolean hasFocus()
Component has focus.

Returns:
true if has focus, false otherwise.

isEditable

boolean isEditable()
Component is editable, contents can be updated in ui


isShowInvisibleBorder

boolean isShowInvisibleBorder()
Component is editable, contents can be updated in ui


isRollover

boolean isRollover()
Component highlight/select border is draw on mouse over.


isMovable

boolean isMovable()
Component is movable.


isResizable

boolean isResizable()
Component is resizable.


isBorderStyle

boolean isBorderStyle()
border has defined style.

Returns:

isSelected

boolean isSelected()

getDocument

org.icepdf.core.pobjects.Document getDocument()

getPageIndex

int getPageIndex()

getParentPageView

PageViewComponent getParentPageView()

setSelected

void setSelected(boolean selected)

repaint

void repaint()

resetAppearanceShapes

void resetAppearanceShapes()

getPageViewComponent

PageViewComponent getPageViewComponent()

dispose

void dispose()