BasicTextUI.BasicCaret

extends DefaultCaret
implements UIResource

java.lang.Object
↳	java.awt.geom.RectangularShape
	↳	java.awt.geom.Rectangle2D
		↳	java.awt.Rectangle
			↳	javax.swing.text.DefaultCaret
				↳	javax.swing.plaf.basic.BasicTextUI.BasicCaret

Summary

[Expand]

Inherited Constants

From class javax.swing.text.DefaultCaret

From class java.awt.geom.Rectangle2D

[Expand]

Inherited Fields

From class javax.swing.text.DefaultCaret

From class java.awt.Rectangle

Public Constructors
	BasicTextUI.BasicCaret()

[Expand]

Inherited Methods

From class javax.swing.text.DefaultCaret

void	addChangeListener(ChangeListener l) Adds a listener to track whenever the caret position has been changed.
void	adjustVisibility(Rectangle nloc) Scrolls the associated view (if necessary) to make the caret visible.
synchronized void	damage(Rectangle r) Damages the area surrounding the caret to cause it to be repainted in a new location.
void	deinstall(JTextComponent c) Called when the UI is being removed from the interface of a JTextComponent.
boolean	equals(Object obj) Compares this object to the specified object.
void	fireStateChanged() Notifies all listeners that have registered interest for notification on this event type.
void	focusGained(FocusEvent e) Called when the component containing the caret gains focus.
void	focusLost(FocusEvent e) Called when the component containing the caret loses focus.
int	getBlinkRate() Gets the caret blink rate.
ChangeListener[]	getChangeListeners() Returns an array of all the change listeners registered on this caret.
final JTextComponent	getComponent() Gets the text editor component that this caret is is bound to.
int	getDot() Fetches the current position of the caret.
Position.Bias	getDotBias() Returns the bias of the caret position.
<T extends EventListener> T[]	getListeners(Class<T> listenerType) Returns an array of all the objects currently registered as `FooListener`s upon this caret.
Point	getMagicCaretPosition() Gets the saved caret position.
int	getMark() Fetches the current position of the mark.
Position.Bias	getMarkBias() Returns the bias of the mark.
Highlighter.HighlightPainter	getSelectionPainter() Gets the painter for the Highlighter.
int	getUpdatePolicy() Gets the caret movement policy on document updates.
void	install(JTextComponent c) Called when the UI is being installed into the interface of a JTextComponent.
boolean	isActive() Determines if the caret is currently active.
boolean	isSelectionVisible() Checks whether the current selection is visible.
boolean	isVisible() Indicates whether or not the caret is currently visible.
void	mouseClicked(MouseEvent e) Called when the mouse is clicked.
void	mouseDragged(MouseEvent e) Moves the caret position according to the mouse pointer's current location.
void	mouseEntered(MouseEvent e) Called when the mouse enters a region.
void	mouseExited(MouseEvent e) Called when the mouse exits a region.
void	mouseMoved(MouseEvent e) Called when the mouse is moved.
void	mousePressed(MouseEvent e) If button 1 is pressed, this is implemented to request focus on the associated text component, and to set the caret position.
void	mouseReleased(MouseEvent e) Called when the mouse is released.
void	moveCaret(MouseEvent e) Tries to move the position of the caret from the coordinates of a mouse event, using viewToModel().
void	moveDot(int dot) Moves the caret position to the specified position, with a forward bias.
void	moveDot(int dot, Position.Bias dotBias) Moves the caret position to the specified position, with the specified bias.
void	paint(Graphics g) Renders the caret as a vertical line.
void	positionCaret(MouseEvent e) Tries to set the position of the caret from the coordinates of a mouse event, using viewToModel().
void	removeChangeListener(ChangeListener l) Removes a listener that was tracking caret position changes.
synchronized final void	repaint() Cause the caret to be painted.
void	setBlinkRate(int rate) Sets the caret blink rate.
void	setDot(int dot) Sets the caret position and mark to the specified position, with a forward bias.
void	setDot(int dot, Position.Bias dotBias) Sets the caret position and mark to the specified position, with the specified bias.
void	setMagicCaretPosition(Point p) Saves the current caret position.
void	setSelectionVisible(boolean vis) Changes the selection visibility.
void	setUpdatePolicy(int policy) Sets the caret movement policy on the document updates.
void	setVisible(boolean e) Sets the caret visibility, and repaints the caret.
String	toString() Returns a `String` representing this `Rectangle` and its values.

From class java.awt.Rectangle

void	add(int newx, int newy) Adds a point, specified by the integer arguments `newx,newy` to the bounds of this `Rectangle`.
void	add(Point pt) Adds the specified `Point` to the bounds of this `Rectangle`.
void	add(Rectangle r) Adds a `Rectangle` to this `Rectangle`.
boolean	contains(Point p) Checks whether or not this `Rectangle` contains the specified `Point`.
boolean	contains(int x, int y) Checks whether or not this `Rectangle` contains the point at the specified location `(x,y)`.
boolean	contains(Rectangle r) Checks whether or not this `Rectangle` entirely contains the specified `Rectangle`.
boolean	contains(int X, int Y, int W, int H) Checks whether this `Rectangle` entirely contains the `Rectangle` at the specified location `(X,Y)` with the specified dimensions `(W,H)`.
Rectangle2D	createIntersection(Rectangle2D r) Returns a new `Rectangle2D` object representing the intersection of this `Rectangle2D` with the specified `Rectangle2D`.
Rectangle2D	createUnion(Rectangle2D r) Returns a new `Rectangle2D` object representing the union of this `Rectangle2D` with the specified `Rectangle2D`.
boolean	equals(Object obj) Checks whether two rectangles are equal.
Rectangle	getBounds() Gets the bounding `Rectangle` of this `Rectangle`.
Rectangle2D	getBounds2D()
double	getHeight() Returns the height of the bounding `Rectangle` in `double` precision.
Point	getLocation() Returns the location of this `Rectangle`.
Dimension	getSize() Gets the size of this `Rectangle`, represented by the returned `Dimension`.
double	getWidth() Returns the width of the bounding `Rectangle` in `double` precision.
double	getX() Returns the X coordinate of the bounding `Rectangle` in `double` precision.
double	getY() Returns the Y coordinate of the bounding `Rectangle` in `double` precision.
void	grow(int h, int v) Resizes the `Rectangle` both horizontally and vertically.
boolean	inside(int X, int Y) This method is deprecated. As of JDK version 1.1, replaced by `contains(int, int)`.
Rectangle	intersection(Rectangle r) Computes the intersection of this `Rectangle` with the specified `Rectangle`.
boolean	intersects(Rectangle r) Determines whether or not this `Rectangle` and the specified `Rectangle` intersect.
boolean	isEmpty() Determines whether the `RectangularShape` is empty.
void	move(int x, int y) This method is deprecated. As of JDK version 1.1, replaced by `setLocation(int, int)`.
int	outcode(double x, double y) Determines where the specified coordinates lie with respect to this `Rectangle2D`.
void	reshape(int x, int y, int width, int height) This method is deprecated. As of JDK version 1.1, replaced by `setBounds(int, int, int, int)`.
void	resize(int width, int height) This method is deprecated. As of JDK version 1.1, replaced by `setSize(int, int)`.
void	setBounds(Rectangle r) Sets the bounding `Rectangle` of this `Rectangle` to match the specified `Rectangle`.
void	setBounds(int x, int y, int width, int height) Sets the bounding `Rectangle` of this `Rectangle` to the specified `x`, `y`, `width`, and `height`.
void	setLocation(Point p) Moves this `Rectangle` to the specified location.
void	setLocation(int x, int y) Moves this `Rectangle` to the specified location.
void	setRect(double x, double y, double width, double height) Sets the bounds of this `Rectangle` to the integer bounds which encompass the specified `x`, `y`, `width`, and `height`.
void	setSize(Dimension d) Sets the size of this `Rectangle` to match the specified `Dimension`.
void	setSize(int width, int height) Sets the size of this `Rectangle` to the specified width and height.
String	toString() Returns a `String` representing this `Rectangle` and its values.
void	translate(int dx, int dy) Translates this `Rectangle` the indicated distance, to the right along the X coordinate axis, and downward along the Y coordinate axis.
Rectangle	union(Rectangle r) Computes the union of this `Rectangle` with the specified `Rectangle`.

From class java.awt.geom.Rectangle2D

void	add(double newx, double newy) Adds a point, specified by the double precision arguments `newx` and `newy`, to this `Rectangle2D`.
void	add(Point2D pt) Adds the `Point2D` object `pt` to this `Rectangle2D`.
void	add(Rectangle2D r) Adds a `Rectangle2D` object to this `Rectangle2D`.
boolean	contains(double x, double y)
boolean	contains(double x, double y, double w, double h)
abstract Rectangle2D	createIntersection(Rectangle2D r) Returns a new `Rectangle2D` object representing the intersection of this `Rectangle2D` with the specified `Rectangle2D`.
abstract Rectangle2D	createUnion(Rectangle2D r) Returns a new `Rectangle2D` object representing the union of this `Rectangle2D` with the specified `Rectangle2D`.
boolean	equals(Object obj) Determines whether or not the specified `Object` is equal to this `Rectangle2D`.
Rectangle2D	getBounds2D()
PathIterator	getPathIterator(AffineTransform at) Returns an iteration object that defines the boundary of this `Rectangle2D`.
PathIterator	getPathIterator(AffineTransform at, double flatness) Returns an iteration object that defines the boundary of the flattened `Rectangle2D`.
int	hashCode() Returns the hashcode for this `Rectangle2D`.
static void	intersect(Rectangle2D src1, Rectangle2D src2, Rectangle2D dest) Intersects the pair of specified source `Rectangle2D` objects and puts the result into the specified destination `Rectangle2D` object.
boolean	intersects(double x, double y, double w, double h)
boolean	intersectsLine(Line2D l) Tests if the specified line segment intersects the interior of this `Rectangle2D`.
boolean	intersectsLine(double x1, double y1, double x2, double y2) Tests if the specified line segment intersects the interior of this `Rectangle2D`.
int	outcode(Point2D p) Determines where the specified `Point2D` lies with respect to this `Rectangle2D`.
abstract int	outcode(double x, double y) Determines where the specified coordinates lie with respect to this `Rectangle2D`.
void	setFrame(double x, double y, double w, double h) Sets the location and size of the outer bounds of this `Rectangle2D` to the specified rectangular values.
abstract void	setRect(double x, double y, double w, double h) Sets the location and size of this `Rectangle2D` to the specified `double` values.
void	setRect(Rectangle2D r) Sets this `Rectangle2D` to be the same as the specified `Rectangle2D`.
static void	union(Rectangle2D src1, Rectangle2D src2, Rectangle2D dest) Unions the pair of source `Rectangle2D` objects and puts the result into the specified destination `Rectangle2D` object.

From class java.awt.geom.RectangularShape

Object	clone() Creates a new object of the same class and with the same contents as this object.
boolean	contains(Point2D p) Tests if a specified `Point2D` is inside the boundary of the `Shape`.
boolean	contains(Rectangle2D r) Tests if the interior of the `Shape` entirely contains the specified `Rectangle2D`.
Rectangle	getBounds() Returns an integer `Rectangle` that completely encloses the `Shape`.
double	getCenterX() Returns the X coordinate of the center of the framing rectangle of the `Shape` in `double` precision.
double	getCenterY() Returns the Y coordinate of the center of the framing rectangle of the `Shape` in `double` precision.
Rectangle2D	getFrame() Returns the framing `Rectangle2D` that defines the overall shape of this object.
abstract double	getHeight() Returns the height of the framing rectangle in `double` precision.
double	getMaxX() Returns the largest X coordinate of the framing rectangle of the `Shape` in `double` precision.
double	getMaxY() Returns the largest Y coordinate of the framing rectangle of the `Shape` in `double` precision.
double	getMinX() Returns the smallest X coordinate of the framing rectangle of the `Shape` in `double` precision.
double	getMinY() Returns the smallest Y coordinate of the framing rectangle of the `Shape` in `double` precision.
PathIterator	getPathIterator(AffineTransform at, double flatness) Returns an iterator object that iterates along the `Shape` object's boundary and provides access to a flattened view of the outline of the `Shape` object's geometry.
abstract double	getWidth() Returns the width of the framing rectangle in `double` precision.
abstract double	getX() Returns the X coordinate of the upper-left corner of the framing rectangle in `double` precision.
abstract double	getY() Returns the Y coordinate of the upper-left corner of the framing rectangle in `double` precision.
boolean	intersects(Rectangle2D r) Tests if the interior of the `Shape` intersects the interior of a specified `Rectangle2D`.
abstract boolean	isEmpty() Determines whether the `RectangularShape` is empty.
void	setFrame(Point2D loc, Dimension2D size) Sets the location and size of the framing rectangle of this `Shape` to the specified `Point2D` and `Dimension2D`, respectively.
void	setFrame(Rectangle2D r) Sets the framing rectangle of this `Shape` to be the specified `Rectangle2D`.
abstract void	setFrame(double x, double y, double w, double h) Sets the location and size of the framing rectangle of this `Shape` to the specified rectangular values.
void	setFrameFromCenter(double centerX, double centerY, double cornerX, double cornerY) Sets the framing rectangle of this `Shape` based on the specified center point coordinates and corner point coordinates.
void	setFrameFromCenter(Point2D center, Point2D corner) Sets the framing rectangle of this `Shape` based on a specified center `Point2D` and corner `Point2D`.
void	setFrameFromDiagonal(double x1, double y1, double x2, double y2) Sets the diagonal of the framing rectangle of this `Shape` based on the two specified coordinates.
void	setFrameFromDiagonal(Point2D p1, Point2D p2) Sets the diagonal of the framing rectangle of this `Shape` based on two specified `Point2D` objects.

From class java.lang.Object

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
final Class<?>	getClass() Returns the runtime class of this `Object`.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait() Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
final void	wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.

From interface java.awt.Shape

abstract boolean	contains(double x, double y) Tests if the specified coordinates are inside the boundary of the `Shape`.
abstract boolean	contains(Point2D p) Tests if a specified `Point2D` is inside the boundary of the `Shape`.
abstract boolean	contains(double x, double y, double w, double h) Tests if the interior of the `Shape` entirely contains the specified rectangular area.
abstract boolean	contains(Rectangle2D r) Tests if the interior of the `Shape` entirely contains the specified `Rectangle2D`.
abstract Rectangle	getBounds() Returns an integer `Rectangle` that completely encloses the `Shape`.
abstract Rectangle2D	getBounds2D() Returns a high precision and more accurate bounding box of the `Shape` than the `getBounds` method.
abstract PathIterator	getPathIterator(AffineTransform at) Returns an iterator object that iterates along the `Shape` boundary and provides access to the geometry of the `Shape` outline.
abstract PathIterator	getPathIterator(AffineTransform at, double flatness) Returns an iterator object that iterates along the `Shape` boundary and provides access to a flattened view of the `Shape` outline geometry.
abstract boolean	intersects(double x, double y, double w, double h) Tests if the interior of the `Shape` intersects the interior of a specified rectangular area.
abstract boolean	intersects(Rectangle2D r) Tests if the interior of the `Shape` intersects the interior of a specified `Rectangle2D`.

From interface java.awt.event.FocusListener

From interface java.awt.event.MouseListener

From interface java.awt.event.MouseMotionListener

From interface javax.swing.text.Caret

abstract void	addChangeListener(ChangeListener l) Adds a listener to track whenever the caret position has been changed.
abstract void	deinstall(JTextComponent c) Called when the UI is being removed from the interface of a JTextComponent.
abstract int	getBlinkRate() Gets the blink rate of the caret.
abstract int	getDot() Fetches the current position of the caret.
abstract Point	getMagicCaretPosition() Gets the current caret visual location.
abstract int	getMark() Fetches the current position of the mark.
abstract void	install(JTextComponent c) Called when the UI is being installed into the interface of a JTextComponent.
abstract boolean	isSelectionVisible() Determines if the selection is currently visible.
abstract boolean	isVisible() Determines if the caret is currently visible.
abstract void	moveDot(int dot) Moves the caret position (dot) to some other position, leaving behind the mark.
abstract void	paint(Graphics g) Renders the caret.
abstract void	removeChangeListener(ChangeListener l) Removes a listener that was tracking caret position changes.
abstract void	setBlinkRate(int rate) Sets the blink rate of the caret.
abstract void	setDot(int dot) Sets the caret position to some position.
abstract void	setMagicCaretPosition(Point p) Set the current caret visual location.
abstract void	setSelectionVisible(boolean v) Sets the visibility of the selection
abstract void	setVisible(boolean v) Sets the visibility of the caret.

Interfaces

Classes

BasicTextUI.BasicCaret

Summary

Public Constructors

public BasicTextUI.BasicCaret ()