SwingConstants
BoxView
public abstract class CompositeView extends View
CompositeView
is an abstract View
implementation which manages one or more child views. (Note that CompositeView
is intended for managing relatively small numbers of child views.) CompositeView
is intended to be used as a starting point for View
implementations, such as BoxView
, that will contain child View
s. Subclasses that wish to manage the collection of child View
s should use the replace(int, int, javax.swing.text.View[])
method. As View
invokes replace
during DocumentListener
notification, you normally won't need to directly invoke replace
. While CompositeView
does not impose a layout policy on its child View
s, it does allow for inseting the child View
s it will contain. The insets can be set by either setInsets(short, short, short, short)
or setParagraphInsets(javax.swing.text.AttributeSet)
.
In addition to the abstract methods of View
, subclasses of CompositeView
will need to override:
isBefore(int, int, java.awt.Rectangle)
- Used to test if a given View
location is before the visual space of the CompositeView
. isAfter(int, int, java.awt.Rectangle)
- Used to test if a given View
location is after the visual space of the CompositeView
. getViewAtPoint(int, int, java.awt.Rectangle)
- Returns the view at a given visual location. childAllocation(int, java.awt.Rectangle)
- Returns the bounds of a particular child View
. getChildAllocation
will invoke childAllocation
after offsetting the bounds by the Inset
s of the CompositeView
. BadBreakWeight, ExcellentBreakWeight, ForcedBreakWeight, GoodBreakWeight, X_AXIS, Y_AXIS
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST
Constructor | Description |
---|---|
CompositeView |
Constructs a CompositeView for the given element. |
Modifier and Type | Method | Description |
---|---|---|
protected abstract void |
childAllocation |
Returns the allocation for a given child. |
protected boolean |
flipEastAndWestAtEnds |
Determines in which direction the next view lays. |
protected short |
getBottomInset() |
Gets the bottom inset. |
Shape |
getChildAllocation |
Fetches the allocation for the given child view to render into. |
protected Rectangle |
getInsideAllocation |
Translates the immutable allocation given to the view to a mutable allocation that represents the interior allocation (i.e. the bounds of the given allocation with the top, left, bottom, and right insets removed. |
protected short |
getLeftInset() |
Gets the left inset. |
protected int |
getNextEastWestVisualPositionFrom |
Returns the next visual position for the cursor, in either the east or west direction. |
protected int |
getNextNorthSouthVisualPositionFrom |
Returns the next visual position for the cursor, in either the north or south direction. |
int |
getNextVisualPositionFrom |
Provides a way to determine the next visually represented model location that one might place a caret. |
protected short |
getRightInset() |
Gets the right inset. |
protected short |
getTopInset() |
Gets the top inset. |
View |
getView |
Returns the n-th view in this container. |
protected abstract View |
getViewAtPoint |
Fetches the child view at the given coordinates. |
protected View |
getViewAtPosition |
Fetches the child view that represents the given position in the model. |
int |
getViewCount() |
Returns the number of child views of this view. |
int |
getViewIndex |
Returns the child view index representing the given position in the model. |
protected int |
getViewIndexAtPosition |
Fetches the child view index representing the given position in the model. |
protected abstract boolean |
isAfter |
Tests whether a point lies after the rectangle range. |
protected abstract boolean |
isBefore |
Tests whether a point lies before the rectangle range. |
protected void |
loadChildren |
Loads all of the children to initialize the view. |
Shape |
modelToView |
Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it. |
Shape |
modelToView |
Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it. |
void |
replace |
Replaces child views. |
protected void |
setInsets |
Sets the insets for the view. |
protected void |
setParagraphInsets |
Sets the insets from the paragraph attributes specified in the given attributes. |
void |
setParent |
Sets the parent of the view. |
int |
viewToModel |
Provides a mapping from the view coordinate space to the logical coordinate space of the model. |
append, breakView, changedUpdate, createFragment, forwardUpdate, forwardUpdateToView, getAlignment, getAttributes, getBreakWeight, getContainer, getDocument, getElement, getEndOffset, getGraphics, getMaximumSpan, getMinimumSpan, getParent, getPreferredSpan, getResizeWeight, getStartOffset, getToolTipText, getViewFactory, getViewIndex, insert, insertUpdate, isVisible, modelToView, paint, preferenceChanged, remove, removeAll, removeUpdate, setSize, updateChildren, updateLayout, viewToModel
public CompositeView(Element elem)
CompositeView
for the given element.elem
- the element this view is responsible forprotected void loadChildren(ViewFactory f)
setParent(javax.swing.text.View)
method. Subclasses can reimplement this to initialize their child views in a different manner. The default implementation creates a child view for each child element.f
- the view factorypublic void setParent(View parent)
loadChildren
method if this view does not already have children. The children should not be loaded in the constructor because the act of setting the parent may cause them to try to search up the hierarchy (to get the hosting Container
for example). If this view has children (the view is being moved from one place in the view hierarchy to another), the loadChildren
method will not be called.public int getViewCount()
getViewCount
in class View
public View getView(int n)
public void replace(int offset, int length, View[] views)
null
, and the internal reference to them removed so that they may be garbage collected.replace
in class View
offset
- the starting index into the child views to insert the new views; >= 0 and <= getViewCountlength
- the number of existing child views to remove; this should be a value >= 0 and <= (getViewCount() - offset)views
- the child views to add; this value can be null
to indicate no children are being added (useful to remove)public Shape getChildAllocation(int index, Shape a)
getChildAllocation
in class View
index
- the index of the child, >= 0 && < getViewCount()a
- the allocation to this viewpublic Shape modelToView(int pos, Shape a, Position.Bias b) throws BadLocationException
modelToView
in class View
pos
- the position to convert >= 0a
- the allocated region to render intob
- a bias value of either Position.Bias.Forward
or Position.Bias.Backward
BadLocationException
- if the given position does not represent a valid location in the associated documentpublic Shape modelToView(int p0, Position.Bias b0, int p1, Position.Bias b1, Shape a) throws BadLocationException
modelToView
in class View
p0
- the position to convert >= 0b0
- the bias toward the previous character or the next character represented by p0, in case the position is a boundary of two views; either Position.Bias.Forward
or Position.Bias.Backward
p1
- the position to convert >= 0b1
- the bias toward the previous character or the next character represented by p1, in case the position is a boundary of two viewsa
- the allocated region to render intoBadLocationException
- if the given position does not represent a valid location in the associated documentIllegalArgumentException
- for an invalid bias argumentpublic int viewToModel(float x, float y, Shape a, Position.Bias[] bias)
viewToModel
in class View
x
- x coordinate of the view location to convert >= 0y
- y coordinate of the view location to convert >= 0a
- the allocated region to render intobias
- either Position.Bias.Forward
or Position.Bias.Backward
public int getNextVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet) throws BadLocationException
getNextNorthSouthVisualPositionFrom(int, javax.swing.text.Position.Bias, java.awt.Shape, int, javax.swing.text.Position.Bias[])
and getNextEastWestVisualPositionFrom(int, javax.swing.text.Position.Bias, java.awt.Shape, int, javax.swing.text.Position.Bias[])
. This method enables specifying a position to convert within the range of >=0. If the value is -1, a position will be calculated automatically. If the value < -1, the BadLocationException
will be thrown.getNextVisualPositionFrom
in class View
pos
- the position to convertb
- a bias value of either Position.Bias.Forward
or Position.Bias.Backward
a
- the allocated region to render intodirection
- the direction from the current position that can be thought of as the arrow keys typically found on a keyboard; this may be one of the following: SwingConstants.WEST
SwingConstants.EAST
SwingConstants.NORTH
SwingConstants.SOUTH
biasRet
- an array containing the bias that was checkedBadLocationException
- the given position is not a valid position within the documentIllegalArgumentException
- if direction
is invalidpublic int getViewIndex(int pos, Position.Bias b)
getViewIndexByPosition
method for backward compatibility.getViewIndex
in class View
pos
- the position >= 0b
- the biasprotected abstract boolean isBefore(int x, int y, Rectangle alloc)
x
- the X coordinate >= 0y
- the Y coordinate >= 0alloc
- the rectangleprotected abstract boolean isAfter(int x, int y, Rectangle alloc)
x
- the X coordinate >= 0y
- the Y coordinate >= 0alloc
- the rectangleprotected abstract View getViewAtPoint(int x, int y, Rectangle alloc)
x
- the X coordinate >= 0y
- the Y coordinate >= 0alloc
- the parent's allocation on entry, which should be changed to the child's allocation on exitprotected abstract void childAllocation(int index, Rectangle a)
index
- the index of the child, >= 0 && < getViewCount()a
- the allocation to the interior of the box on entry, and the allocation of the child view at the index on exit.protected View getViewAtPosition(int pos, Rectangle a)
pos
- the position >= 0a
- the allocation to the interior of the box on entry, and the allocation of the view containing the position on exitnull
if there isn't oneprotected int getViewIndexAtPosition(int pos)
pos
- the position >= 0protected Rectangle getInsideAllocation(Shape a)
childAllocation
method.a
- the allocation given to the viewnull
, the return value is null
protected void setParagraphInsets(AttributeSet attr)
attr
- the attributesprotected void setInsets(short top, short left, short bottom, short right)
top
- the top inset >= 0left
- the left inset >= 0bottom
- the bottom inset >= 0right
- the right inset >= 0protected short getLeftInset()
protected short getRightInset()
protected short getTopInset()
protected short getBottomInset()
protected int getNextNorthSouthVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet) throws BadLocationException
pos
- the position to convert >= 0b
- a bias value of either Position.Bias.Forward
or Position.Bias.Backward
a
- the allocated region to render intodirection
- the direction from the current position that can be thought of as the arrow keys typically found on a keyboard; this may be one of the following: SwingConstants.NORTH
SwingConstants.SOUTH
biasRet
- an array containing the bias that was checkedBadLocationException
- for a bad location within a document modelIllegalArgumentException
- if direction
is invalidprotected int getNextEastWestVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet) throws BadLocationException
pos
- the position to convert >= 0b
- a bias value of either Position.Bias.Forward
or Position.Bias.Backward
a
- the allocated region to render intodirection
- the direction from the current position that can be thought of as the arrow keys typically found on a keyboard; this may be one of the following: SwingConstants.WEST
SwingConstants.EAST
biasRet
- an array containing the bias that was checkedBadLocationException
- for a bad location within a document modelIllegalArgumentException
- if direction
is invalidprotected boolean flipEastAndWestAtEnds(int position, Position.Bias bias)
View
at index n. Typically the View
s are laid out from left to right, so that the View
to the EAST will be at index n + 1, and the View
to the WEST will be at index n - 1. In certain situations, such as with bidirectional text, it is possible that the View
to EAST is not at index n + 1, but rather at index n - 1, or that the View
to the WEST is not at index n - 1, but index n + 1. In this case this method would return true, indicating the View
s are laid out in descending order. This unconditionally returns false, subclasses should override this method if there is the possibility for laying View
s in descending order.
position
- position into the modelbias
- either Position.Bias.Forward
or Position.Bias.Backward
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/swing/text/CompositeView.html