-
- All Known Implementing Classes:
AbstractAnnotationComponent,AbstractButtonComponent,AbstractChoiceComponent,AnnotationSummaryBox,CheckButtonComponent,ChoiceComboComponent,ChoiceListComponent,CircleAnnotationComponent,FreeTextAnnotationComponent,InkAnnotationComponent,LineAnnotationComponent,LinkAnnotationComponent,MarkupAnnotationComponent,PolygonAnnotationComponent,PolyLineAnnotationComponent,PopupAnnotationComponent,PushButtonComponent,RadioButtonComponent,RedactionAnnotationComponent,SignatureComponent,SquareAnnotationComponent,TextAnnotationComponent,TextMarkupAnnotationComponent,TextWidgetComponent,WidgetAnnotationComponent
public interface AnnotationComponentAnnotationComponent interfaces. Outlines 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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voiddispose()Dispose this component resources.AnnotationgetAnnotation()Gets wrapped annotation object.DocumentgetDocument()Document that annotation belows too.intgetPageIndex()Page index that annotation component resides on.PageViewComponentgetPageViewComponent()Gets the parent page view that displays this component.booleanhasFocus()Component has focus.booleanisActive()booleanisBorderStyle()border has defined style.booleanisEditable()Component is editable, contents can be updated in uibooleanisMovable()Component is movable.booleanisResizable()Component is resizable.booleanisRollover()Component highlight/select border is draw on mouse over.booleanisSelected()Annotation is in a selected state.booleanisShowInvisibleBorder()Component is editable, contents can be updated in uibooleanisSynthetic()voidrefreshAnnotationRect()Refreshed the annotation rectangle by inverting the components current bounds with the current page transformation.voidrefreshDirtyBounds()Refresh the annotations bounds rectangle.voidrepaint()Repaints this componentvoidresetAppearanceShapes()Rest the annotation appearance stream.voidsetSelected(boolean selected)Sets the selected statevoidsetSynthetic(boolean synthetic)
-
-
-
Method Detail
-
getAnnotation
Annotation getAnnotation()
Gets wrapped annotation object.- Returns:
- annotation that this component wraps.
-
refreshDirtyBounds
void refreshDirtyBounds()
Refresh 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- Returns:
- true if has editable, false otherwise.
-
isShowInvisibleBorder
boolean isShowInvisibleBorder()
Component is editable, contents can be updated in ui- Returns:
- true if show invisible border, false otherwise.
-
isRollover
boolean isRollover()
Component highlight/select border is draw on mouse over.- Returns:
- true if is rollover, false otherwise.
-
isMovable
boolean isMovable()
Component is movable.- Returns:
- true if movable, false otherwise.
-
isResizable
boolean isResizable()
Component is resizable.- Returns:
- true if resizable, false otherwise.
-
isBorderStyle
boolean isBorderStyle()
border has defined style.- Returns:
- true if has border style, false otherwise.
-
isActive
boolean isActive()
-
isSelected
boolean isSelected()
Annotation is in a selected state. Used for drawing a highlighted state.- Returns:
- is selected
-
getDocument
Document getDocument()
Document that annotation belows too.- Returns:
- document parent.
-
getPageIndex
int getPageIndex()
Page index that annotation component resides on.- Returns:
- page index of parent page
-
setSelected
void setSelected(boolean selected)
Sets the selected state- Parameters:
selected- selected state.
-
repaint
void repaint()
Repaints this component
-
resetAppearanceShapes
void resetAppearanceShapes()
Rest the annotation appearance stream.
-
getPageViewComponent
PageViewComponent getPageViewComponent()
Gets the parent page view that displays this component.- Returns:
- parent component.
-
dispose
void dispose()
Dispose this component resources.
-
isSynthetic
boolean isSynthetic()
-
setSynthetic
void setSynthetic(boolean synthetic)
-
-