org.fife.ui.rtextarea
public class ConfigurableCaret extends DefaultCaret
RTextArea
. This caret has all of the properties
that javax.swing.text.DefaultCaret
does, as well as adding the
following niceties:
DefaultCaret
)Rectangle2D.Double, Rectangle2D.Float
Modifier and Type | Field and Description |
---|---|
static int |
BLOCK_BORDER_STYLE
The block border style.
|
static int |
BLOCK_STYLE
The block style.
|
static int |
MAX_STYLE
The maximum value of a caret style.
|
static int |
MIN_STYLE
The minimum value of a caret style.
|
static int |
THICK_VERTICAL_LINE_STYLE
A thicker vertical line (2 pixels instead of 1).
|
static int |
UNDERLINE_STYLE
The horizontal line style.
|
static int |
VERTICAL_LINE_STYLE
The vertical line style.
|
ALWAYS_UPDATE, changeEvent, listenerList, NEVER_UPDATE, UPDATE_WHEN_ON_EDT
OUT_BOTTOM, OUT_LEFT, OUT_RIGHT, OUT_TOP
Constructor and Description |
---|
ConfigurableCaret()
Creates the caret using
VERTICAL_LINE_STYLE . |
ConfigurableCaret(int style)
Constructs a new
ConfigurableCaret . |
Modifier and Type | Method and Description |
---|---|
protected void |
damage(Rectangle r)
Overridden to damage the correct width of the caret, since this caret
can be different sizes.
|
void |
deinstall(JTextComponent c)
Called when the UI is being removed from the
interface of a JTextComponent.
|
boolean |
getRoundedSelectionEdges()
Returns whether this caret's selection uses rounded edges.
|
protected Highlighter.HighlightPainter |
getSelectionPainter()
Gets the painter for the Highlighter.
|
int |
getStyle()
Gets the current style of this caret.
|
protected RTextArea |
getTextArea()
Gets the text editor component that this caret is bound to.
|
void |
install(JTextComponent c)
Installs this caret on a text component.
|
void |
mouseClicked(MouseEvent e)
Called when the mouse is clicked.
|
void |
paint(Graphics g)
Paints the cursor.
|
void |
setRoundedSelectionEdges(boolean rounded)
Sets whether this caret's selection should have rounded edges.
|
void |
setSelectionVisible(boolean visible)
Overridden to always render the selection, even when the text component
loses focus.
|
void |
setStyle(int style)
Sets the style used when painting the caret.
|
addChangeListener, adjustVisibility, equals, fireStateChanged, focusGained, focusLost, getBlinkRate, getChangeListeners, getComponent, getDot, getDotBias, getListeners, getMagicCaretPosition, getMark, getMarkBias, getUpdatePolicy, isActive, isSelectionVisible, isVisible, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, moveCaret, moveDot, moveDot, positionCaret, removeChangeListener, repaint, setBlinkRate, setDot, setDot, setMagicCaretPosition, setUpdatePolicy, setVisible, toString
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
add, add, add, contains, contains, getPathIterator, getPathIterator, hashCode, intersect, intersects, intersectsLine, intersectsLine, outcode, setFrame, setRect, union
clone, contains, contains, getCenterX, getCenterY, getFrame, getMaxX, getMaxY, getMinX, getMinY, intersects, setFrame, setFrame, setFrameFromCenter, setFrameFromCenter, setFrameFromDiagonal, setFrameFromDiagonal
finalize, getClass, notify, notifyAll, wait, wait, wait
contains, contains, contains, contains, getPathIterator, getPathIterator, intersects, intersects
public static final int MIN_STYLE
public static final int VERTICAL_LINE_STYLE
public static final int UNDERLINE_STYLE
public static final int BLOCK_STYLE
public static final int BLOCK_BORDER_STYLE
public static final int THICK_VERTICAL_LINE_STYLE
public static final int MAX_STYLE
public ConfigurableCaret()
VERTICAL_LINE_STYLE
.public ConfigurableCaret(int style)
ConfigurableCaret
.style
- The style to use when painting the caret. If this is
invalid, then VERTICAL_LINE_STYLE
is used.protected void damage(Rectangle r)
damage
in class DefaultCaret
r
- The current location of the caret.public void deinstall(JTextComponent c)
deinstall
in interface Caret
deinstall
in class DefaultCaret
c
- The text component. If this is not an
RTextArea
, an Exception
will be thrown.Caret.deinstall(javax.swing.text.JTextComponent)
protected RTextArea getTextArea()
RTextArea
.public boolean getRoundedSelectionEdges()
setRoundedSelectionEdges(boolean)
protected Highlighter.HighlightPainter getSelectionPainter()
getSelectionPainter
in class DefaultCaret
public int getStyle()
setStyle(int)
public void install(JTextComponent c)
install
in interface Caret
install
in class DefaultCaret
c
- The text component. If this is not an RTextArea
,
an Exception
will be thrown.Caret.install(javax.swing.text.JTextComponent)
public void mouseClicked(MouseEvent e)
mouseClicked
in interface MouseListener
mouseClicked
in class DefaultCaret
e
- the mouse eventMouseListener.mouseClicked(java.awt.event.MouseEvent)
public void paint(Graphics g)
paint
in interface Caret
paint
in class DefaultCaret
g
- The graphics context in which to paint.public void setRoundedSelectionEdges(boolean rounded)
rounded
- Whether it should have rounded edges.getRoundedSelectionEdges()
public void setSelectionVisible(boolean visible)
setSelectionVisible
in interface Caret
setSelectionVisible
in class DefaultCaret
visible
- Whether the selection should be visible. This parameter
is ignored.public void setStyle(int style)
style
- The style to use. If this isn't one of
VERTICAL_LINE_STYLE
, UNDERLINE_STYLE
,
or BLOCK_STYLE
, then
VERTICAL_LINE_STYLE
is used.getStyle()