DefaultCaret JDK 1.6)

Methods

public void add (double newx, double newy) [Inherited From Rectangle2D]

Adds a point, specified by the double precision arguments newx and newy, to this Rectangle2D.

Adds a point, specified by the double precision arguments newx and newy, to this Rectangle2D. The resulting Rectangle2D is the smallest Rectangle2D that contains both the original Rectangle2D and the specified point.

After adding a point, a call to contains with the added point as an argument does not necessarily return true. The contains method does not return true for points on the right or bottom edges of a rectangle. Therefore, if the added point falls on the left or bottom edge of the enlarged rectangle, contains returns false for that point.
Parameters:
- newx - the X coordinate of the new point
- newy - the Y coordinate of the new point
Since: 1.2

public void add (int newx, int newy) [Inherited From Rectangle]

Adds a point, specified by the integer arguments newx,newy to the bounds of this Rectangle.

If this Rectangle has any dimension less than zero, the rules for non-existant rectangles apply. In that case, the new bounds of this Rectangle will have a location equal to the specified coordinates and width and height equal to zero.

After adding a point, a call to contains with the added point as an argument does not necessarily return true. The contains method does not return true for points on the right or bottom edges of a Rectangle. Therefore, if the added point falls on the right or bottom edge of the enlarged Rectangle, contains returns false for that point. If the specified point must be contained within the new Rectangle, a 1x1 rectangle should be added instead:

     r.add(newx, newy, 1, 1);

Parameters:
- newx - the X coordinate of the new point
- newy - the Y coordinate of the new point

public void add (Point pt) [Inherited From Rectangle]

Adds the specified Point to the bounds of this Rectangle.

If this Rectangle has any dimension less than zero, the rules for non-existant rectangles apply. In that case, the new bounds of this Rectangle will have a location equal to the coordinates of the specified Point and width and height equal to zero.

After adding a Point, a call to contains with the added Point as an argument does not necessarily return true. The contains method does not return true for points on the right or bottom edges of a Rectangle. Therefore if the added Point falls on the right or bottom edge of the enlarged Rectangle, contains returns false for that Point. If the specified point must be contained within the new Rectangle, a 1x1 rectangle should be added instead:

     r.add(pt.x, pt.y, 1, 1);

Parameters:
- pt - the new Point to add to this Rectangle

public void add (Point2D pt) [Inherited From Rectangle2D]

Adds the Point2D object pt to this Rectangle2D.

Adds the Point2D object pt to this Rectangle2D. The resulting Rectangle2D is the smallest Rectangle2D that contains both the original Rectangle2D and the specified Point2D.

After adding a point, a call to contains with the added point as an argument does not necessarily return true. The contains method does not return true for points on the right or bottom edges of a rectangle. Therefore, if the added point falls on the left or bottom edge of the enlarged rectangle, contains returns false for that point.
Parameters:
- pt - the new Point2D to add to this Rectangle2D.
Since: 1.2

public void add (Rectangle r) [Inherited From Rectangle]

Adds a Rectangle to this Rectangle.

Adds a Rectangle to this Rectangle. The resulting Rectangle is the union of the two rectangles.

If either Rectangle has any dimension less than 0, the result will have the dimensions of the other Rectangle. If both Rectangles have at least one dimension less than 0, the result will have at least one dimension less than 0.

If either Rectangle has one or both dimensions equal to 0, the result along those axes with 0 dimensions will be equivalent to the results obtained by adding the corresponding origin coordinate to the result rectangle along that axis, similar to the operation of the Rectangle.add(Point) method, but contribute no further dimension beyond that.

If the resulting Rectangle would have a dimension too large to be expressed as an int, the result will have a dimension of Integer.MAX_VALUE along that dimension.
Parameters:
- r - the specified Rectangle

public void add (Rectangle2D r) [Inherited From Rectangle2D]

Adds a Rectangle2D object to this Rectangle2D.

Adds a Rectangle2D object to this
Rectangle2D. The resulting Rectangle2D
is the union of the two Rectangle2D objects.
Parameters:
- r - the Rectangle2D to add to this Rectangle2D.
Since: 1.2

public void addChangeListener (ChangeListener l) [Specified in Caret]

Adds a listener to track whenever the caret position has been changed.

pack-private void adjustCaretAndFocus (MouseEvent e)

protected void adjustVisibility (Rectangle nloc)

Scrolls the associated view (if necessary) to make the caret visible.

pack-private void changeCaretPosition (int dot, Bias dotBias)

Sets the caret position (dot) to a new location.

public Object clone () [Inherited From RectangularShape]

Creates a new object of the same class and with the same contents as this object.

public boolean contains (double x, double y) [Inherited From Rectangle2D]

Tests if the specified coordinates are inside the boundary of the Shape.

Tests if the specified coordinates are inside the boundary of the
Shape.
Since: 1.2

public boolean contains (double x, double y, double w, double h) [Inherited From Rectangle2D]

Tests if the interior of the Shape entirely contains the specified rectangular area.

Tests if the interior of the Shape entirely contains the specified rectangular area. All coordinates that lie inside the rectangular area must lie within the Shape for the entire rectanglar area to be considered contained within the Shape.

The Shape.contains() method allows a Shape implementation to conservatively return false when:

the intersect method returns true and
the calculations to determine whether or not the Shape entirely contains the rectangular area are prohibitively expensive.

This means that for some Shapes this method might return false even though the Shape contains the rectangular area. The Area class performs more accurate geometric computations than most Shape objects and therefore can be used if a more precise answer is required.
Since: 1.2

public boolean contains (int x, int y) [Inherited From Rectangle]

Checks whether or not this Rectangle contains the point at the specified location (x,y).

Checks whether or not this Rectangle contains the
point at the specified location (x,y).
Returns: true if the point {@code (x,y)} is inside this Rectangle; false otherwise.
Parameters:
- x - the specified X coordinate
- y - the specified Y coordinate
Since: 1.1

public boolean contains (int X, int Y, int W, int H) [Inherited From Rectangle]

Checks whether this Rectangle entirely contains the Rectangle at the specified location (X,Y) with the specified dimensions (W,H).

Checks whether this Rectangle entirely contains
the Rectangle
at the specified location (X,Y) with the
specified dimensions (W,H).
Returns: true if the Rectangle specified by {@code (X, Y, W, H)} is entirely enclosed inside this Rectangle; false otherwise.
Parameters:
- X - the specified X coordinate
- Y - the specified Y coordinate
- W - the width of the Rectangle
- H - the height of the Rectangle
Since: 1.1

public boolean contains (Point p) [Inherited From Rectangle]

Checks whether or not this Rectangle contains the specified Point.

Checks whether or not this Rectangle contains the
specified Point.
Returns: true if the specified Point is inside this Rectangle; false otherwise.
Parameters:
- p - the Point to test
Since: 1.1

public boolean contains (Point2D p) [Inherited From RectangularShape]

Tests if a specified Point2D is inside the boundary of the Shape.

Tests if a specified Point2D is inside the boundary
of the Shape.
Since: 1.2

public boolean contains (Rectangle r) [Inherited From Rectangle]

Checks whether or not this Rectangle entirely contains the specified Rectangle.

Checks whether or not this Rectangle entirely contains
the specified Rectangle.
Returns: true if the Rectangle is contained entirely inside this Rectangle; false otherwise
Parameters:
- r - the specified Rectangle
Since: 1.2

public boolean contains (Rectangle2D r) [Inherited From RectangularShape]

Tests if the interior of the Shape entirely contains the specified Rectangle2D.

Tests if the interior of the Shape entirely contains the
specified Rectangle2D.
The Shape.contains() method allows a Shape
implementation to conservatively return false when:

the intersect method returns true and
the calculations to determine whether or not the
Shape entirely contains the Rectangle2D
are prohibitively expensive.

This means that for some Shapes this method might
return false even though the Shape contains
the Rectangle2D.
The Area class performs
more accurate geometric computations than most
Shape objects and therefore can be used if a more precise
answer is required.
Since: 1.2

public Rectangle2D createIntersection (Rectangle2D r) [Inherited From Rectangle] [Specified in Rectangle2D]

Returns a new Rectangle2D object representing the intersection of this Rectangle2D with the specified Rectangle2D.

Returns a new Rectangle2D object representing the
intersection of this Rectangle2D with the specified
Rectangle2D.
Since: 1.2

public Rectangle2D createUnion (Rectangle2D r) [Inherited From Rectangle] [Specified in Rectangle2D]

Returns a new Rectangle2D object representing the union of this Rectangle2D with the specified Rectangle2D.

Returns a new Rectangle2D object representing the
union of this Rectangle2D with the specified
Rectangle2D.
Since: 1.2

protectedsynchronized void damage (Rectangle r)

Damages the area surrounding the caret to cause it to be repainted in a new location.

public void deinstall (JTextComponent c) [Specified in Caret]

Called when the UI is being removed from the interface of a JTextComponent.

public boolean equals (Object obj) [Overrides Rectangle]

Compares this object to the specified object.

Compares this object to the specified object.
The superclass behavior of comparing rectangles
is not desired, so this is changed to the Object
behavior.
Returns: true if the objects are equal; false otherwise
Parameters:
- obj - the object to compare this font with

protected void fireStateChanged ()

Notifies all listeners that have registered interest for notification on this event type.

public void focusGained (FocusEvent e) [Specified in FocusListener]

Called when the component containing the caret gains focus.

public void focusLost (FocusEvent e) [Specified in FocusListener]

Called when the component containing the caret loses focus.

public int getBlinkRate () [Specified in Caret]

Gets the caret blink rate.

public Rectangle getBounds () [Inherited From Rectangle]

Gets the bounding Rectangle of this Rectangle.

This method is included for completeness, to parallel the getBounds method of Component.
Returns: a new Rectangle, equal to the bounding Rectangle for this Rectangle.
Since: 1.1
See Also: Component.getBounds(), Rectangle.setBounds(Rectangle), Rectangle.setBounds(int, int, int, int),

public Rectangle2D getBounds2D () [Inherited From Rectangle]

Returns a high precision and more accurate bounding box of the Shape than the getBounds method. Note that there is no guarantee that the returned Rectangle2D is the smallest bounding box that encloses the Shape, only that the Shape lies entirely within the indicated Rectangle2D. The bounding box returned by this method is usually tighter than that returned by the getBounds method and never fails due to overflow problems since the return value can be an instance of the Rectangle2D that uses double precision values to store the dimensions.

Returns a high precision and more accurate bounding box of
the Shape than the getBounds method.
Note that there is no guarantee that the returned
Rectangle2D is the smallest bounding box that encloses
the Shape, only that the Shape lies
entirely within the indicated Rectangle2D. The
bounding box returned by this method is usually tighter than that
returned by the getBounds method and never fails due
to overflow problems since the return value can be an instance of
the Rectangle2D that uses double precision values to
store the dimensions.
Since: 1.2

pack-private int getCaretWidth (int height)

public double getCenterX () [Inherited From RectangularShape]

Returns the X coordinate of the center of the framing rectangle of the Shape in double precision.

Returns the X coordinate of the center of the framing
rectangle of the Shape in double
precision.
Returns: the X coordinate of the center of the framing rectangle of the Shape.
Since: 1.2

public double getCenterY () [Inherited From RectangularShape]

Returns the Y coordinate of the center of the framing rectangle of the Shape in double precision.

Returns the Y coordinate of the center of the framing
rectangle of the Shape in double
precision.
Returns: the Y coordinate of the center of the framing rectangle of the Shape.
Since: 1.2

public ChangeListener getChangeListeners ()

Returns an array of all the change listeners registered on this caret.

Returns an array of all the change listeners
registered on this caret.
Returns: all of this caret's ChangeListeners or an empty array if no change listeners are currently registered
Since: 1.4
See Also: DefaultCaret.addChangeListener(javax.swing.event.ChangeListener), DefaultCaret.removeChangeListener(javax.swing.event.ChangeListener),

protectedfinal JTextComponent getComponent ()

Gets the text editor component that this caret is is bound to.

public int getDot () [Specified in Caret]

Fetches the current position of the caret.

public Bias getDotBias ()

Returns the bias of the caret position.

public Rectangle2D getFrame () [Inherited From RectangularShape]

Returns the framing Rectangle2D that defines the overall shape of this object.

Returns the framing Rectangle2D
that defines the overall shape of this object.
Returns: a Rectangle2D, specified in double coordinates.
Since: 1.2
See Also: RectangularShape.setFrame(double, double, double, double), RectangularShape.setFrame(Point2D, Dimension2D), RectangularShape.setFrame(Rectangle2D),

public double getHeight () [Inherited From Rectangle] [Specified in RectangularShape]

Returns the height of the bounding Rectangle in double precision.

Returns the height of the bounding Rectangle in
double precision.
Returns: the height of the bounding Rectangle.

public T getListeners (Class< T> listenerType)

Returns an array of all the objects currently registered as FooListeners upon this caret.

Returns an array of all the objects currently registered as FooListeners upon this caret. FooListeners are registered using the addFooListener method.

You can specify the listenerType argument with a class literal, such as FooListener.class. For example, you can query a DefaultCaret c for its change listeners with the following code:

ChangeListener[] cls = (ChangeListener[])(c.getListeners(ChangeListener.class));

If no such listeners exist, this method returns an empty array.
Returns: an array of all objects registered as FooListeners on this component, or an empty array if no such listeners have been added
Parameters:
- listenerType - the type of listeners requested; this parameter should specify an interface that descends from java.util.EventListener
Throws:
- ClassCastException - if listenerType doesn't specify a class or interface that implements java.util.EventListener
Since: 1.3
See Also: DefaultCaret.getChangeListeners(),

public Point getLocation () [Inherited From Rectangle]

Returns the location of this Rectangle.

This method is included for completeness, to parallel the getLocation method of Component.
Returns: the Point that is the upper-left corner of this Rectangle.
Since: 1.1
See Also: Component.getLocation(), Rectangle.setLocation(Point), Rectangle.setLocation(int, int),

public Point getMagicCaretPosition () [Specified in Caret]

Gets the saved caret position.

public int getMark () [Specified in Caret]

Fetches the current position of the mark.

public Bias getMarkBias ()

Returns the bias of the mark.

public double getMaxX () [Inherited From RectangularShape]

Returns the largest X coordinate of the framing rectangle of the Shape in double precision.

Returns the largest X coordinate of the framing
rectangle of the Shape in double
precision.
Returns: the largest X coordinate of the framing rectangle of the Shape.
Since: 1.2

public double getMaxY () [Inherited From RectangularShape]

Returns the largest Y coordinate of the framing rectangle of the Shape in double precision.

Returns the largest Y coordinate of the framing
rectangle of the Shape in double
precision.
Returns: the largest Y coordinate of the framing rectangle of the Shape.
Since: 1.2

public double getMinX () [Inherited From RectangularShape]

Returns the smallest X coordinate of the framing rectangle of the Shape in double precision.

Returns the smallest X coordinate of the framing
rectangle of the Shape in double
precision.
Returns: the smallest X coordinate of the framing rectangle of the Shape.
Since: 1.2

public double getMinY () [Inherited From RectangularShape]

Returns the smallest Y coordinate of the framing rectangle of the Shape in double precision.

Returns the smallest Y coordinate of the framing
rectangle of the Shape in double
precision.
Returns: the smallest Y coordinate of the framing rectangle of the Shape.
Since: 1.2

public PathIterator getPathIterator (AffineTransform at) [Inherited From Rectangle2D]

Returns an iteration object that defines the boundary of this Rectangle2D.

Returns an iteration object that defines the boundary of this
Rectangle2D.
The iterator for this class is multi-threaded safe, which means
that this Rectangle2D class guarantees that
modifications to the geometry of this Rectangle2D
object do not affect any iterations of that geometry that
are already in process.
Returns: the PathIterator object that returns the geometry of the outline of this Rectangle2D, one segment at a time.
Parameters:
- at - an optional AffineTransform to be applied to the coordinates as they are returned in the iteration, or null if untransformed coordinates are desired
Since: 1.2

public PathIterator getPathIterator (AffineTransform at, double flatness) [Inherited From Rectangle2D]

Returns an iteration object that defines the boundary of the flattened Rectangle2D.

Returns an iteration object that defines the boundary of the
flattened Rectangle2D. Since rectangles are already
flat, the flatness parameter is ignored.
The iterator for this class is multi-threaded safe, which means
that this Rectangle2D class guarantees that
modifications to the geometry of this Rectangle2D
object do not affect any iterations of that geometry that
are already in process.
Returns: the PathIterator object that returns the geometry of the outline of this Rectangle2D, one segment at a time.
Parameters:
- at - an optional AffineTransform to be applied to the coordinates as they are returned in the iteration, or null if untransformed coordinates are desired
- flatness - the maximum distance that the line segments used to approximate the curved segments are allowed to deviate from any point on the original curve. Since rectangles are already flat, the flatness parameter is ignored.
Since: 1.2

protected HighlightPainter getSelectionPainter ()

Gets the painter for the Highlighter.

public Dimension getSize () [Inherited From Rectangle]

Gets the size of this Rectangle, represented by the returned Dimension.

This method is included for completeness, to parallel the getSize method of Component.
Returns: a Dimension, representing the size of this Rectangle.
Since: 1.1
See Also: Component.getSize(), Rectangle.setSize(Dimension), Rectangle.setSize(int, int),

public int getUpdatePolicy ()

Gets the caret movement policy on document updates.

Gets the caret movement policy on document updates.
Returns: one of the following values : UPDATE_WHEN_ON_EDT, NEVER_UPDATE, ALWAYS_UPDATE
Since: 1.5
See Also: DefaultCaret.setUpdatePolicy(int), DefaultCaret.UPDATE_WHEN_ON_EDT, DefaultCaret.NEVER_UPDATE, DefaultCaret.ALWAYS_UPDATE,

public double getWidth () [Inherited From Rectangle] [Specified in RectangularShape]

Returns the width of the bounding Rectangle in double precision.

Returns the width of the bounding Rectangle in
double precision.
Returns: the width of the bounding Rectangle.

public double getX () [Inherited From Rectangle] [Specified in RectangularShape]

Returns the X coordinate of the bounding Rectangle in double precision.

Returns the X coordinate of the bounding Rectangle in
double precision.
Returns: the X coordinate of the bounding Rectangle.

public double getY () [Inherited From Rectangle] [Specified in RectangularShape]

Returns the Y coordinate of the bounding Rectangle in double precision.

Returns the Y coordinate of the bounding Rectangle in
double precision.
Returns: the Y coordinate of the bounding Rectangle.

public void grow (int h, int v) [Inherited From Rectangle]

Resizes the Rectangle both horizontally and vertically.

This method modifies the Rectangle so that it is h units larger on both the left and right side, and v units larger at both the top and bottom.

The new Rectangle has (x - h, y - v) as its upper-left corner, width of (width + 2h), and a height of (height + 2v).

If negative values are supplied for h and v, the size of the Rectangle decreases accordingly. The grow method will check for integer overflow and underflow, but does not check whether the resulting values of width and height grow from negative to non-negative or shrink from non-negative to negative.
Parameters:
- h - the horizontal expansion
- v - the vertical expansion

pack-private Bias guessBiasForOffset (int offset, Bias lastBias, boolean lastLTR)

pack-private void handleMoveDot (int dot, Bias dotBias)

pack-private void handleSetDot (int dot, Bias dotBias)

public int hashCode () [Inherited From Rectangle2D]

Returns the hashcode for this Rectangle2D.

Returns the hashcode for this Rectangle2D.
Returns: the hashcode for this Rectangle2D.
Since: 1.2

@Deprecated

public boolean ~~inside~~ (int X, int Y) [Inherited From Rectangle]

Checks whether or not this Rectangle contains the point at the specified location (X,Y).

Checks whether or not this Rectangle contains the
point at the specified location (X,Y).
Returns: true if the point {@code (X,Y)} is inside this Rectangle; false otherwise.
Parameters:
- X - the specified X coordinate
- Y - the specified Y coordinate

public void install (JTextComponent c) [Specified in Caret]

Called when the UI is being installed into the interface of a JTextComponent.

publicstatic void intersect (Rectangle2D src1, Rectangle2D src2, Rectangle2D dest) [Inherited From Rectangle2D]

Intersects the pair of specified source Rectangle2D objects and puts the result into the specified destination Rectangle2D object.

Intersects the pair of specified source Rectangle2D
objects and puts the result into the specified destination
Rectangle2D object. One of the source rectangles
can also be the destination to avoid creating a third Rectangle2D
object, but in this case the original points of this source
rectangle will be overwritten by this method.
Parameters:
- src1 - the first of a pair of Rectangle2D objects to be intersected with each other
- src2 - the second of a pair of Rectangle2D objects to be intersected with each other
- dest - the Rectangle2D that holds the results of the intersection of src1 and src2
Since: 1.2

public Rectangle intersection (Rectangle r) [Inherited From Rectangle]

Computes the intersection of this Rectangle with the specified Rectangle.

Computes the intersection of this Rectangle with the
specified Rectangle. Returns a new Rectangle
that represents the intersection of the two rectangles.
If the two rectangles do not intersect, the result will be
an empty rectangle.
Returns: the largest Rectangle contained in both the specified Rectangle and in this Rectangle; or if the rectangles do not intersect, an empty rectangle.
Parameters:
- r - the specified Rectangle

public boolean intersects (double x, double y, double w, double h) [Inherited From Rectangle2D]

Tests if the interior of the Shape intersects the interior of a specified rectangular area.

Tests if the interior of the Shape intersects the interior of a specified rectangular area. The rectangular area is considered to intersect the Shape if any point is contained in both the interior of the Shape and the specified rectangular area.

The Shape.intersects() method allows a Shape implementation to conservatively return true when:

there is a high probability that the rectangular area and the Shape intersect, but
the calculations to accurately determine this intersection are prohibitively expensive.

This means that for some Shapes this method might return true even though the rectangular area does not intersect the Shape. The Area class performs more accurate computations of geometric intersection than most Shape objects and therefore can be used if a more precise answer is required.
Since: 1.2

public boolean intersects (Rectangle r) [Inherited From Rectangle]

Determines whether or not this Rectangle and the specified Rectangle intersect.

Determines whether or not this Rectangle and the specified
Rectangle intersect. Two rectangles intersect if
their intersection is nonempty.
Returns: true if the specified Rectangle and this Rectangle intersect; false otherwise.
Parameters:
- r - the specified Rectangle

public boolean intersects (Rectangle2D r) [Inherited From RectangularShape]

Tests if the interior of the Shape intersects the interior of a specified Rectangle2D.

Tests if the interior of the Shape intersects the
interior of a specified Rectangle2D.
The Shape.intersects() method allows a Shape
implementation to conservatively return true when:

there is a high probability that the Rectangle2D and the
Shape intersect, but
the calculations to accurately determine this intersection
are prohibitively expensive.

This means that for some Shapes this method might
return true even though the Rectangle2D does not
intersect the Shape.
The Area class performs
more accurate computations of geometric intersection than most
Shape objects and therefore can be used if a more precise
answer is required.
Since: 1.2

public boolean intersectsLine (double x1, double y1, double x2, double y2) [Inherited From Rectangle2D]

Tests if the specified line segment intersects the interior of this Rectangle2D.

Tests if the specified line segment intersects the interior of this
Rectangle2D.
Returns: true if the specified line segment intersects the interior of this Rectangle2D; false otherwise.
Parameters:
- x1 - the X coordinate of the start point of the specified line segment
- y1 - the Y coordinate of the start point of the specified line segment
- x2 - the X coordinate of the end point of the specified line segment
- y2 - the Y coordinate of the end point of the specified line segment
Since: 1.2

public boolean intersectsLine (Line2D l) [Inherited From Rectangle2D]

Tests if the specified line segment intersects the interior of this Rectangle2D.

Tests if the specified line segment intersects the interior of this
Rectangle2D.
Returns: true if the specified Line2D intersects the interior of this Rectangle2D; false otherwise.
Parameters:
- l - the specified {@link Line2D} to test for intersection with the interior of this Rectangle2D
Since: 1.2

public boolean isActive ()

Determines if the caret is currently active.

pack-private boolean isDotLeftToRight ()

public boolean isEmpty () [Inherited From Rectangle] [Specified in RectangularShape]

Determines whether the RectangularShape is empty.

Determines whether the RectangularShape is empty.
When the RectangularShape is empty, it encloses no
area.
Since: 1.2

pack-private boolean isMarkLeftToRight ()

pack-private boolean isPositionLTR (int position, Bias bias)

public boolean isSelectionVisible () [Specified in Caret]

Checks whether the current selection is visible.

public boolean isVisible () [Specified in Caret]

Indicates whether or not the caret is currently visible.

Indicates whether or not the caret is currently visible. As the caret flashes on and off the return value of this will change between true, when the caret is painted, and false, when the caret is not painted. isActive indicates whether or not the caret is in a blinking state, such that it can be visible, and isVisible indicates whether or not the caret is actually visible.

Subclasses that wish to render a different flashing caret should override paint and only paint the caret if this method returns true.
Returns: true if visible else false
See Also: Caret.isVisible(), DefaultCaret.isActive(),

public void mouseClicked (MouseEvent e) [Specified in MouseListener]

Called when the mouse is clicked.

public void mouseDragged (MouseEvent e) [Specified in MouseMotionListener]

Moves the caret position according to the mouse pointer's current location.

public void mouseEntered (MouseEvent e) [Specified in MouseListener]

Called when the mouse enters a region.

public void mouseExited (MouseEvent e) [Specified in MouseListener]

Called when the mouse exits a region.

public void mouseMoved (MouseEvent e) [Specified in MouseMotionListener]

Called when the mouse is moved.

public void mousePressed (MouseEvent e) [Specified in MouseListener]

If button 1 is pressed, this is implemented to request focus on the associated text component, and to set the caret position.

public void mouseReleased (MouseEvent e) [Specified in MouseListener]

Called when the mouse is released.

@Deprecated

public void ~~move~~ (int x, int y) [Inherited From Rectangle]

Moves this Rectangle to the specified location.

Parameters:
- x - the X coordinate of the new location
- y - the Y coordinate of the new location

protected void moveCaret (MouseEvent e)

Tries to move the position of the caret from the coordinates of a mouse event, using viewToModel().

public void moveDot (int dot) [Specified in Caret]

Moves the caret position to the specified position, with a forward bias.

public void moveDot (int dot, Bias dotBias)

Moves the caret position to the specified position, with the specified bias.

Moves the caret position to the specified position, with the
specified bias.
Parameters:
- dot - the position >= 0
- dotBias - the bias for this position, not null
Throws:
- IllegalArgumentException - if the bias is null
Since: 1.6
See Also: Caret.moveDot(int),

public int outcode (double x, double y) [Inherited From Rectangle] [Specified in Rectangle2D]

Determines where the specified coordinates lie with respect to this Rectangle2D.

Determines where the specified coordinates lie with respect
to this Rectangle2D.
This method computes a binary OR of the appropriate mask values
indicating, for each side of this Rectangle2D,
whether or not the specified coordinates are on the same side
of the edge as the rest of this Rectangle2D.
Since: 1.2

public int outcode (Point2D p) [Inherited From Rectangle2D]

Determines where the specified Point2D lies with respect to this Rectangle2D.

Determines where the specified Point2D lies with
respect to this Rectangle2D.
This method computes a binary OR of the appropriate mask values
indicating, for each side of this Rectangle2D,
whether or not the specified Point2D is on the same
side of the edge as the rest of this Rectangle2D.
Returns: the logical OR of all appropriate out codes.
Parameters:
- p - the specified Point2D
Since: 1.2
See Also: Rectangle2D.OUT_LEFT, Rectangle2D.OUT_TOP, Rectangle2D.OUT_RIGHT, Rectangle2D.OUT_BOTTOM,

public void paint (Graphics g) [Specified in Caret]

Renders the caret as a vertical line.

protected void positionCaret (MouseEvent e)

Tries to set the position of the caret from the coordinates of a mouse event, using viewToModel().

public void removeChangeListener (ChangeListener l) [Specified in Caret]

Removes a listener that was tracking caret position changes.

protectedfinalsynchronized void repaint ()

Cause the caret to be painted.

pack-private void repaintNewCaret ()

Repaints the new caret position, with the assumption that this is happening on the event thread so that calling modelToView is safe.

@Deprecated

public void ~~reshape~~ (int x, int y, int width, int height) [Inherited From Rectangle]

Sets the bounding Rectangle of this Rectangle to the specified x, y, width, and height.

Parameters:
- x - the new X coordinate for the upper-left corner of this Rectangle
- y - the new Y coordinate for the upper-left corner of this Rectangle
- width - the new width for this Rectangle
- height - the new height for this Rectangle

@Deprecated

public void ~~resize~~ (int width, int height) [Inherited From Rectangle]

Sets the size of this Rectangle to the specified width and height.

Parameters:
- width - the new width for this Rectangle
- height - the new height for this Rectangle

public void setBlinkRate (int rate) [Specified in Caret]

Sets the caret blink rate.

public void setBounds (int x, int y, int width, int height) [Inherited From Rectangle]

Sets the bounding Rectangle of this Rectangle to the specified x, y, width, and height.

This method is included for completeness, to parallel the setBounds method of Component.
Parameters:
- x - the new X coordinate for the upper-left corner of this Rectangle
- y - the new Y coordinate for the upper-left corner of this Rectangle
- width - the new width for this Rectangle
- height - the new height for this Rectangle
Since: 1.1
See Also: Rectangle.getBounds(), Component.setBounds(int, int, int, int),

public void setBounds (Rectangle r) [Inherited From Rectangle]

Sets the bounding Rectangle of this Rectangle to match the specified Rectangle.

This method is included for completeness, to parallel the setBounds method of Component.
Parameters:
- r - the specified Rectangle
Since: 1.1
See Also: Rectangle.getBounds(), Component.setBounds(java.awt.Rectangle),

public void setDot (int dot) [Specified in Caret]

Sets the caret position and mark to the specified position, with a forward bias.

public void setDot (int dot, Bias dotBias)

Sets the caret position and mark to the specified position, with the specified bias.

Sets the caret position and mark to the specified position, with the
specified bias. This implicitly sets the selection range
to zero.
Parameters:
- dot - the position >= 0
- dotBias - the bias for this position, not null
Throws:
- IllegalArgumentException - if the bias is null
Since: 1.6
See Also: Caret.setDot(int),

public void setFrame (double x, double y, double w, double h) [Inherited From Rectangle2D] [Specified in RectangularShape]

Sets the location and size of the outer bounds of this Rectangle2D to the specified rectangular values.

Sets the location and size of the outer bounds of this
Rectangle2D to the specified rectangular values.
Parameters:
- x - the X coordinate of the upper-left corner of this Rectangle2D
- y - the Y coordinate of the upper-left corner of this Rectangle2D
- w - the width of this Rectangle2D
- h - the height of this Rectangle2D
Since: 1.2

public void setFrame (Point2D loc, Dimension2D size) [Inherited From RectangularShape]

Sets the location and size of the framing rectangle of this Shape to the specified Point2D and Dimension2D, respectively.

Sets the location and size of the framing rectangle of this
Shape to the specified Point2D and
Dimension2D, respectively. The framing rectangle is used
by the subclasses of RectangularShape to define
their geometry.
Parameters:
- loc - the specified Point2D
- size - the specified Dimension2D
Since: 1.2
See Also: RectangularShape.getFrame(),

public void setFrame (Rectangle2D r) [Inherited From RectangularShape]

Sets the framing rectangle of this Shape to be the specified Rectangle2D.

Sets the framing rectangle of this Shape to
be the specified Rectangle2D. The framing rectangle is
used by the subclasses of RectangularShape to define
their geometry.
Parameters:
- r - the specified Rectangle2D
Since: 1.2
See Also: RectangularShape.getFrame(),

public void setFrameFromCenter (double centerX, double centerY, double cornerX, double cornerY) [Inherited From RectangularShape]

Sets the framing rectangle of this Shape based on the specified center point coordinates and corner point coordinates.

Sets the framing rectangle of this Shape
based on the specified center point coordinates and corner point
coordinates. The framing rectangle is used by the subclasses of
RectangularShape to define their geometry.
Parameters:
- centerX - the X coordinate of the specified center point
- centerY - the Y coordinate of the specified center point
- cornerX - the X coordinate of the specified corner point
- cornerY - the Y coordinate of the specified corner point
Since: 1.2

public void setFrameFromCenter (Point2D center, Point2D corner) [Inherited From RectangularShape]

Sets the framing rectangle of this Shape based on a specified center Point2D and corner Point2D.

Sets the framing rectangle of this Shape based on a
specified center Point2D and corner
Point2D. The framing rectangle is used by the subclasses
of RectangularShape to define their geometry.
Parameters:
- center - the specified center Point2D
- corner - the specified corner Point2D
Since: 1.2

public void setFrameFromDiagonal (double x1, double y1, double x2, double y2) [Inherited From RectangularShape]

Sets the diagonal of the framing rectangle of this Shape based on the two specified coordinates.

Sets the diagonal of the framing rectangle of this Shape
based on the two specified coordinates. The framing rectangle is
used by the subclasses of RectangularShape to define
their geometry.
Parameters:
- x1 - the X coordinate of the start point of the specified diagonal
- y1 - the Y coordinate of the start point of the specified diagonal
- x2 - the X coordinate of the end point of the specified diagonal
- y2 - the Y coordinate of the end point of the specified diagonal
Since: 1.2

public void setFrameFromDiagonal (Point2D p1, Point2D p2) [Inherited From RectangularShape]

Sets the diagonal of the framing rectangle of this Shape based on two specified Point2D objects.

Sets the diagonal of the framing rectangle of this Shape
based on two specified Point2D objects. The framing
rectangle is used by the subclasses of RectangularShape
to define their geometry.
Parameters:
- p1 - the start Point2D of the specified diagonal
- p2 - the end Point2D of the specified diagonal
Since: 1.2

public void setLocation (int x, int y) [Inherited From Rectangle]

Moves this Rectangle to the specified location.

This method is included for completeness, to parallel the setLocation method of Component.
Parameters:
- x - the X coordinate of the new location
- y - the Y coordinate of the new location
Since: 1.1
See Also: Rectangle.getLocation(), Component.setLocation(int, int),

public void setLocation (Point p) [Inherited From Rectangle]

Moves this Rectangle to the specified location.

This method is included for completeness, to parallel the setLocation method of Component.
Parameters:
- p - the Point specifying the new location for this Rectangle
Since: 1.1
See Also: Component.setLocation(java.awt.Point), Rectangle.getLocation(),

public void setMagicCaretPosition (Point p) [Specified in Caret]

Saves the current caret position.

public void setRect (double x, double y, double width, double height) [Inherited From Rectangle] [Specified in Rectangle2D]

Sets the bounds of this Rectangle to the integer bounds which encompass the specified x, y, width, and height.

Sets the bounds of this Rectangle to the integer bounds
which encompass the specified x, y, width,
and height.
If the parameters specify a Rectangle that exceeds the
maximum range of integers, the result will be the best
representation of the specified Rectangle intersected
with the maximum integer bounds.
Parameters:
- x - the X coordinate of the upper-left corner of the specified rectangle
- y - the Y coordinate of the upper-left corner of the specified rectangle
- width - the width of the specified rectangle
- height - the new height of the specified rectangle

public void setRect (Rectangle2D r) [Inherited From Rectangle2D]

Sets this Rectangle2D to be the same as the specified Rectangle2D.

Sets this Rectangle2D to be the same as the specified
Rectangle2D.
Parameters:
- r - the specified Rectangle2D
Since: 1.2

public void setSelectionVisible (boolean vis) [Specified in Caret]

Changes the selection visibility.

public void setSize (Dimension d) [Inherited From Rectangle]

Sets the size of this Rectangle to match the specified Dimension.

This method is included for completeness, to parallel the setSize method of Component.
Parameters:
- d - the new size for the Dimension object
Since: 1.1
See Also: Component.setSize(java.awt.Dimension), Rectangle.getSize(),

public void setSize (int width, int height) [Inherited From Rectangle]

Sets the size of this Rectangle to the specified width and height.

This method is included for completeness, to parallel the setSize method of Component.
Parameters:
- width - the new width for this Rectangle
- height - the new height for this Rectangle
Since: 1.1
See Also: Component.setSize(int, int), Rectangle.getSize(),

public void setUpdatePolicy (int policy)

Sets the caret movement policy on the document updates.

Sets the caret movement policy on the document updates. Normally the caret updates its absolute position within the document on insertions occurred before or at the caret position and on removals before the caret position. 'Absolute position' means here the position relative to the start of the document. For example if a character is typed within editable text component it is inserted at the caret position and the caret moves to the next absolute position within the document due to insertion and if BACKSPACE is typed then caret decreases its absolute position due to removal of a character before it. Sometimes it may be useful to turn off the caret position updates so that the caret stays at the same absolute position within the document position regardless of any document updates.

The following update policies are allowed:

NEVER_UPDATE: the caret stays at the same absolute position in the document regardless of any document updates, except when document length becomes less than the current caret position due to removal. In that case caret position is adjusted to the end of the document. The caret doesn't try to keep itself visible by scrolling the associated view when using this policy.
ALWAYS_UPDATE: the caret always tracks document changes. For regular changes it increases its position if an insertion occurs before or at its current position, and decreases position if a removal occurs before its current position. For undo/redo updates it is always moved to the position where update occurred. The caret also tries to keep itself visible by calling adjustVisibility method.
UPDATE_WHEN_ON_EDT: acts like ALWAYS_UPDATE if the document updates are performed on the Event Dispatching Thread and like NEVER_UPDATE if updates are performed on other thread.

The default property value is UPDATE_WHEN_ON_EDT.
Parameters:
- policy - one of the following values : UPDATE_WHEN_ON_EDT, NEVER_UPDATE, ALWAYS_UPDATE
Throws:
- IllegalArgumentException - if invalid value is passed
Since: 1.5
See Also: DefaultCaret.getUpdatePolicy(), DefaultCaret.adjustVisibility(java.awt.Rectangle), DefaultCaret.UPDATE_WHEN_ON_EDT, DefaultCaret.NEVER_UPDATE, DefaultCaret.ALWAYS_UPDATE,

public void setVisible (boolean e) [Specified in Caret]

Sets the caret visibility, and repaints the caret.

Sets the caret visibility, and repaints the caret. It is important to understand the relationship between this method, isVisible and isActive. Calling this method with a value of true activates the caret blinking. Setting it to false turns it completely off. To determine whether the blinking is active, you should call isActive. In effect, isActive is an appropriate corresponding "getter" method for this one. isVisible can be used to fetch the current visibility status of the caret, meaning whether or not it is currently painted. This status will change as the caret blinks on and off.

Here's a list showing the potential return values of both isActive and isVisible after calling this method:

setVisible(true):

isActive(): true
isVisible(): true or false depending on whether or not the caret is blinked on or off

setVisible(false):

isActive(): false
isVisible(): false

Parameters:
- e - the visibility specifier
See Also: DefaultCaret.isActive(), Caret.setVisible(boolean),

public String toString () [Overrides Rectangle]

public void translate (int dx, int dy) [Inherited From Rectangle]

Translates this Rectangle the indicated distance, to the right along the X coordinate axis, and downward along the Y coordinate axis.

Translates this Rectangle the indicated distance,
to the right along the X coordinate axis, and
downward along the Y coordinate axis.
Parameters:
- dx - the distance to move this Rectangle along the X axis
- dy - the distance to move this Rectangle along the Y axis
See Also: Rectangle.setLocation(int, int), Rectangle.setLocation(java.awt.Point),

public Rectangle union (Rectangle r) [Inherited From Rectangle]

Computes the union of this Rectangle with the specified Rectangle.

Computes the union of this Rectangle with the specified Rectangle. Returns a new Rectangle that represents the union of the two rectangles.

If either Rectangle has any dimension less than zero the rules for non-existant rectangles apply. If only one has a dimension less than zero, then the result will be a copy of the other Rectangle. If both have dimension less than zero, then the result will have at least one dimension less than zero.

If the resulting Rectangle would have a dimension too large to be expressed as an int, the result will have a dimension of Integer.MAX_VALUE along that dimension.
Returns: the smallest Rectangle containing both the specified Rectangle and this Rectangle.
Parameters:
- r - the specified Rectangle

publicstatic void union (Rectangle2D src1, Rectangle2D src2, Rectangle2D dest) [Inherited From Rectangle2D]

Unions the pair of source Rectangle2D objects and puts the result into the specified destination Rectangle2D object.

Unions the pair of source Rectangle2D objects
and puts the result into the specified destination
Rectangle2D object. One of the source rectangles
can also be the destination to avoid creating a third Rectangle2D
object, but in this case the original points of this source
rectangle will be overwritten by this method.
Parameters:
- src1 - the first of a pair of Rectangle2D objects to be combined with each other
- src2 - the second of a pair of Rectangle2D objects to be combined with each other
- dest - the Rectangle2D that holds the results of the union of src1 and src2
Since: 1.2