Class TranscriptEditorCaret

java.lang.Object

java.awt.geom.RectangularShape

java.awt.geom.Rectangle2D

java.awt.Rectangle

javax.swing.text.DefaultCaret

ca.phon.app.session.editor.view.transcript.TranscriptEditorCaret

All Implemented Interfaces:

FocusListener, MouseListener, MouseMotionListener, Shape, Serializable, Cloneable, EventListener, Caret

public class TranscriptEditorCaret
extends DefaultCaret

Custom caret implementation for TranscriptEditor.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.awt.geom.Rectangle2D

Rectangle2D.Double, Rectangle2D.Float

Field Summary

Fields inherited from class javax.swing.text.DefaultCaret

ALWAYS_UPDATE, changeEvent, listenerList, NEVER_UPDATE, UPDATE_WHEN_ON_EDT

Fields inherited from class java.awt.Rectangle

height, width, x, y

Fields inherited from class java.awt.geom.Rectangle2D

OUT_BOTTOM, OUT_LEFT, OUT_RIGHT, OUT_TOP

Constructor Summary

Constructors

Constructor	Description
TranscriptEditorCaret()

Method Summary

Modifier and Type	Method	Description
void	addCaretHook(TranscriptEditorCaretHook hook)	Add a caret hook
void	freeze()
TranscriptElementLocation	getCurrentLocation()	Get the current location of the caret in the transcript
int	getLineHeight(int dot)	Get the height of the line at the given dot
TranscriptElementLocation	getPreviousLocation()	Get the previous location of the caret in the transcript
TranscriptElementLocation	getTranscriptLocation(int caretOffset)	Get caret transcript location
void	install(JTextComponent c)
boolean	isFreezeCaret()
void	moveDot(int dot, Position.Bias bias)
void	paint(Graphics g)
void	removeCaretHook(TranscriptEditorCaretHook hook)	Remove a caret hook
void	setDot(int dot, boolean force)
void	setDot(int dot, Position.Bias bias)
void	setDot(int dot, Position.Bias bias, boolean force)
void	setFreezeCaret(boolean freezeCaret)
void	unfreeze()

Methods inherited from class javax.swing.text.DefaultCaret

addChangeListener, adjustVisibility, damage, deinstall, equals, fireStateChanged, focusGained, focusLost, getBlinkRate, getChangeListeners, getComponent, getDot, getDotBias, getListeners, getMagicCaretPosition, getMark, getMarkBias, getSelectionPainter, getUpdatePolicy, isActive, isSelectionVisible, isVisible, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, moveCaret, moveDot, positionCaret, removeChangeListener, repaint, setBlinkRate, setDot, setMagicCaretPosition, setSelectionVisible, setUpdatePolicy, setVisible, toString

Methods inherited from class java.awt.Rectangle

add, add, add, contains, contains, contains, contains, createIntersection, createUnion, getBounds, getBounds2D, getHeight, getLocation, getSize, getWidth, getX, getY, grow, inside, intersection, intersects, isEmpty, move, outcode, reshape, resize, setBounds, setBounds, setLocation, setLocation, setRect, setSize, setSize, translate, union

Methods inherited from class java.awt.geom.Rectangle2D

add, add, add, contains, contains, getPathIterator, getPathIterator, hashCode, intersect, intersects, intersectsLine, intersectsLine, outcode, setFrame, setRect, union

Methods inherited from class java.awt.geom.RectangularShape

clone, contains, contains, getCenterX, getCenterY, getFrame, getMaxX, getMaxY, getMinX, getMinY, intersects, setFrame, setFrame, setFrameFromCenter, setFrameFromCenter, setFrameFromDiagonal, setFrameFromDiagonal

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.awt.Shape

contains, contains, contains, contains, getPathIterator, getPathIterator, intersects, intersects

Constructor Details

TranscriptEditorCaret

public TranscriptEditorCaret()

Method Details

install

public void install(JTextComponent c)

Specified by:

install in interface Caret

Overrides:

install in class DefaultCaret

paint

public void paint(Graphics g)

Specified by:

paint in interface Caret

Overrides:

paint in class DefaultCaret

getLineHeight

public int getLineHeight(int dot)

Get the height of the line at the given dot

Parameters:

dot -

Returns:

height of line or 0 if line height could not be determined

isFreezeCaret

public boolean isFreezeCaret()

setFreezeCaret

public void setFreezeCaret(boolean freezeCaret)

freeze

public void freeze()

unfreeze

public void unfreeze()

setDot

public void setDot(int dot,
 boolean force)

setDot

public void setDot(int dot,
 Position.Bias bias)

Overrides:

setDot in class DefaultCaret

setDot

public void setDot(int dot,
 Position.Bias bias,
 boolean force)

moveDot

public void moveDot(int dot,
 Position.Bias bias)

Overrides:

moveDot in class DefaultCaret

getTranscriptLocation

public TranscriptElementLocation getTranscriptLocation(int caretOffset)

Get caret transcript location

getCurrentLocation

public TranscriptElementLocation getCurrentLocation()

Get the current location of the caret in the transcript

Returns:

the current location if set

getPreviousLocation

public TranscriptElementLocation getPreviousLocation()

Get the previous location of the caret in the transcript

Returns:

the previous location if any

addCaretHook

public void addCaretHook(TranscriptEditorCaretHook hook)

Add a caret hook

Parameters:

hook - the hook to add

removeCaretHook

public void removeCaretHook(TranscriptEditorCaretHook hook)

Remove a caret hook

Parameters:

hook - the hook to remove