com.levigo.jadice.annotation
Class HistoryAnnotation

java.lang.Object
  com.levigo.jadice.annotation.Annotation
      com.levigo.jadice.annotation.ShapeBasedAnnotation
          com.levigo.jadice.annotation.RectangleAnnotation
              com.levigo.jadice.annotation.TextAnnotation
                  com.levigo.jadice.annotation.HistoryAnnotation

All Implemented Interfaces:

PermissionsProvider<Annotation>, PropertiesProvider, MementoOriginator, Cloneable

public class HistoryAnnotation
extends TextAnnotation

Nested Class Summary

static class

HistoryAnnotation.HistoryPatternPosition

Field Summary

protected String

secureText Due to technical reasons the field modifier of the secure text content is protected.

Fields inherited from class com.levigo.jadice.annotation.TextAnnotation

bold, defaultText, editable, fontFace, fontSize, italic, scaleText, strikethrough, text, textColor, underscored

Fields inherited from class com.levigo.jadice.annotation.RectangleAnnotation

shape

Fields inherited from class com.levigo.jadice.annotation.ShapeBasedAnnotation

allowResize, fillColor, filled, iconified, linePainted, lineWidth, strokeColor, strokeResolution

Fields inherited from class com.levigo.jadice.annotation.Annotation

createdAt, createdBy, doFireAnnotationEvents, id, initializer, isModified, lastModifiedAt, lastModifiedBy

Constructor Summary

HistoryAnnotation()

Method Summary

HistoryAnnotation	clone()
protected void	copyAttributesTo(Annotation annotation) Copy annotation type related attributes to new annotation.
String	getEntireText() Returns entire text (new text + history pattern + secure text)
String	getHistoryPattern() Returns current history pattern
HistoryAnnotation.HistoryPatternPosition	getPatternPosition() Return current pattern position.
void	setEntireText(String entireText) Sets the entire text, this method should be used by the reader- / writer-implementations.
void	setHistoryPattern(String historyPattern) Set history pattern displayed as non editable text.
void	setPatternPosition(HistoryAnnotation.HistoryPatternPosition patternPosition) Set history pattern position, possible values see HistoryAnnotation.HistoryPatternPosition.

Methods inherited from class com.levigo.jadice.annotation.TextAnnotation

getDefaultText, getFont, getFontFace, getFontSize, getMaxCharacters, getText, getTextColor, isBold, isEditable, isItalic, isScaleText, isStrikethrough, isUnderscored, setBold, setDefaultText, setEditable, setFontFace, setFontSize, setItalic, setMaxCharacters, setScaleText, setStrikethrough, setText, setTextColor, setUnderscored

Methods inherited from class com.levigo.jadice.annotation.RectangleAnnotation

getBounds, getRectangle, getShape, setLocation, setRectangle, setSize, translate

Methods inherited from class com.levigo.jadice.annotation.ShapeBasedAnnotation

createColorWithAlpha, getFillColor, getLineWidth, getStrokeColor, getStrokeResolution, isAllowResize, isFilled, isIconified, isLinePainted, setAllowResize, setFillColor, setFilled, setIconified, setLinePainted, setLineWidth, setStrokeColor, setStrokeResolution

Methods inherited from class com.levigo.jadice.annotation.Annotation

clearModified, createMemento, fireAnnotationChange, getChangeHandler, getCreatedAt, getCreatedBy, getID, getInitializer, getLastModifiedAt, getLastModifiedBy, getModCount, getPermissions, getProperties, getType, initialize, isDoFireAnnotationEvents, isInitialized, isModified, restoreFrom, setChangeHandler, setCreatedBy, setCreationTimestamp, setDoFireAnnotationEvents, setID, setInitializer, setLastModifiedBy, setModified, setModifyTimestamp, setType

Methods inherited from class java.lang.Object

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

Field Detail

secureText

protected String secureText

Due to technical reasons the field modifier of the secure text content is protected. It is strongly recommended not to change the secureText field in any direct way using the protected field access.

Constructor Detail

HistoryAnnotation

public HistoryAnnotation()

Method Detail

getEntireText

public String getEntireText()

Returns entire text (new text + history pattern + secure text)

Returns:

Entire text

setEntireText

public void setEntireText(String entireText)

Sets the entire text, this method should be used by the reader- / writer-implementations.

Parameters:

entireText -

clone

public HistoryAnnotation clone()

Overrides:

clone in class TextAnnotation

See Also:

Object.clone()

copyAttributesTo

protected void copyAttributesTo(Annotation annotation)

Description copied from class: Annotation

Copy annotation type related attributes to new annotation.

Overrides:

copyAttributesTo in class TextAnnotation

Parameters:

annotation - Annotation to set attributes

setHistoryPattern

public void setHistoryPattern(String historyPattern)

Set history pattern displayed as non editable text.

Parameters:

historyPattern - History pattern to set

getHistoryPattern

public String getHistoryPattern()

Returns current history pattern

Returns:

History pattern

getPatternPosition

public HistoryAnnotation.HistoryPatternPosition getPatternPosition()

Return current pattern position.

Returns:

Pattern position

setPatternPosition

public void setPatternPosition(HistoryAnnotation.HistoryPatternPosition patternPosition)

Set history pattern position, possible values see HistoryAnnotation.HistoryPatternPosition.

Parameters:

patternPosition -