| java.lang.Object
 javax.swing.text.View
javax.swing.text.CompositeView
All known Subclasses: javax.swing.text.BoxView,
| CompositeView | | abstract public class CompositeView extends View (Code) | | 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
Views. Subclasses that wish to manage the
collection of child Views should use the
CompositeView.replace 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 Views,
it does allow for inseting the child Views
it will contain. The insets can be set by either
CompositeView.setInsets or
CompositeView.setParagraphInsets .
In addition to the abstract methods of
javax.swing.text.View ,
subclasses of CompositeView will need to
override:
author:
Timothy Prinzing
version:
1.75 05/05/07 |
| Constructor Summary | |
| public | CompositeView(Element elem)
Constructs a CompositeView for the given element. |
| Method Summary | |
| abstract protected void | childAllocation(int index, Rectangle a)
Returns the allocation for a given child. | | protected boolean | flipEastAndWestAtEnds(int position, Position.Bias bias)
Determines in which direction the next view lays.
Consider the View at index n. | | protected short | getBottomInset()
Gets the bottom inset. | | public Shape | getChildAllocation(int index, Shape a)
Fetches the allocation for the given child view to
render into. | | protected Rectangle | getInsideAllocation(Shape a)
Translates the immutable allocation given to the view
to a mutable allocation that represents the interior
allocation (i.e. | | protected short | getLeftInset()
Gets the left inset. | | protected int | getNextEastWestVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet)
Returns the next visual position for the cursor, in either the
east or west direction. | | protected int | getNextNorthSouthVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet)
Returns the next visual position for the cursor, in either the
north or south direction. | | public int | getNextVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet)
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. | | public View | getView(int n)
Returns the n-th view in this container. | | abstract protected View | getViewAtPoint(int x, int y, Rectangle alloc)
Fetches the child view at the given coordinates. | | protected View | getViewAtPosition(int pos, Rectangle a)
Fetches the child view that represents the given position in
the model. | | public int | getViewCount()
Returns the number of child views of this view. | | public int | getViewIndex(int pos, Position.Bias b)
Returns the child view index representing the given
position in the model. | | protected int | getViewIndexAtPosition(int pos)
Fetches the child view index representing the given position in
the model. | | abstract protected boolean | isAfter(int x, int y, Rectangle alloc)
Tests whether a point lies after the rectangle range. | | abstract protected boolean | isBefore(int x, int y, Rectangle alloc)
Tests whether a point lies before the rectangle range. | | protected void | loadChildren(ViewFactory f)
Loads all of the children to initialize the view.
This is called by the
CompositeView.setParent method. | | public Shape | modelToView(int pos, Shape a, Position.Bias b)
Provides a mapping from the document model coordinate space
to the coordinate space of the view mapped to it. | | public Shape | modelToView(int p0, Position.Bias b0, int p1, Position.Bias b1, Shape a)
Provides a mapping from the document model coordinate space
to the coordinate space of the view mapped to it. | | public void | replace(int offset, int length, View[] views)
Replaces child views. | | protected void | setInsets(short top, short left, short bottom, short right)
Sets the insets for the view. | | protected void | setParagraphInsets(AttributeSet attr)
Sets the insets from the paragraph attributes specified in
the given attributes. | | public void | setParent(View parent)
Sets the parent of the view.
This is reimplemented to provide the superclass
behavior as well as calling the loadChildren
method if this view does not already have children. | | public int | viewToModel(float x, float y, Shape a, Position.Bias[] bias)
Provides a mapping from the view coordinate space to the logical
coordinate space of the model. |
| CompositeView | | public CompositeView(Element elem)(Code) | | Constructs a CompositeView for the given element.
Parameters:
elem - the element this view is responsible for |
| childAllocation | | abstract protected void childAllocation(int index, Rectangle a)(Code) | | Returns the allocation for a given child.
Parameters:
index - the index of the child, >= 0 && < getViewCount()
Parameters:
a - the allocation to the interior of the box on entry, and the allocation of the child view at the index on exit. |
| flipEastAndWestAtEnds | | protected boolean flipEastAndWestAtEnds(int position, Position.Bias bias)(Code) | | Determines in which direction the next view lays.
Consider the View at index n. Typically the
Views are layed 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
Views are layed out in descending order.
This unconditionally returns false, subclasses should override this
method if there is the possibility for laying Views in
descending order.
Parameters:
position - position into the model
Parameters:
bias - either Position.Bias.Forward orPosition.Bias.Backward false |
| getBottomInset | | protected short getBottomInset()(Code) | | Gets the bottom inset.
the inset >= 0 |
| getChildAllocation | | public Shape getChildAllocation(int index, Shape a)(Code) | | Fetches the allocation for the given child view to
render into. This enables finding out where various views
are located.
Parameters:
index - the index of the child, >= 0 && < getViewCount()
Parameters:
a - the allocation to this view the allocation to the child |
| getInsideAllocation | | protected Rectangle getInsideAllocation(Shape a)(Code) | | 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.
It is expected that the returned value would be further
mutated to represent an allocation to a child view.
This is implemented to reuse an instance variable so
it avoids creating excessive Rectangles. Typically
the result of calling this method would be fed to
the childAllocation method.
Parameters:
a - the allocation given to the view the allocation that represents the inside of the view after the margins have all been removed; if thegiven allocation was null,the return value is null |
| getLeftInset | | protected short getLeftInset()(Code) | | Gets the left inset.
the inset >= 0 |
| getNextEastWestVisualPositionFrom | | protected int getNextEastWestVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet) throws BadLocationException(Code) | | Returns the next visual position for the cursor, in either the
east or west direction.
Parameters:
pos - the position to convert >= 0
Parameters:
b - a bias value of either Position.Bias.Forwardor Position.Bias.Backward
Parameters:
a - the allocated region to render into
Parameters:
direction - the direction from the current position that canbe thought of as the arrow keys typically found on a keyboard;this may be one of the following:SwingConstants.WESTSwingConstants.EAST
Parameters:
biasRet - an array containing the bias that was checked the location within the model that best represents the nextwest or east location
exception:
BadLocationException -
exception:
IllegalArgumentException - if direction is invalid
See Also: CompositeView.getNextVisualPositionFrom |
| getNextNorthSouthVisualPositionFrom | | protected int getNextNorthSouthVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet) throws BadLocationException(Code) | | Returns the next visual position for the cursor, in either the
north or south direction.
Parameters:
pos - the position to convert >= 0
Parameters:
b - a bias value of either Position.Bias.Forwardor Position.Bias.Backward
Parameters:
a - the allocated region to render into
Parameters:
direction - the direction from the current position that canbe thought of as the arrow keys typically found on a keyboard;this may be one of the following:SwingConstants.NORTHSwingConstants.SOUTH
Parameters:
biasRet - an array containing the bias that was checked the location within the model that best represents the nextnorth or south location
exception:
BadLocationException -
exception:
IllegalArgumentException - if direction is invalid
See Also: CompositeView.getNextVisualPositionFrom the next position west of the passed in position |
| getNextVisualPositionFrom | | public int getNextVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet) throws BadLocationException(Code) | | Provides a way to determine the next visually represented model
location that one might place a caret. Some views may not be visible,
they might not be in the same order found in the model, or they just
might not allow access to some of the locations in the model.
This is a convenience method for
CompositeView.getNextNorthSouthVisualPositionFrom and
CompositeView.getNextEastWestVisualPositionFrom .
Parameters:
pos - the position to convert >= 0
Parameters:
b - a bias value of either Position.Bias.Forwardor Position.Bias.Backward
Parameters:
a - the allocated region to render into
Parameters:
direction - the direction from the current position that canbe thought of as the arrow keys typically found on a keyboard;this may be one of the following: SwingConstants.WESTSwingConstants.EAST SwingConstants.NORTHSwingConstants.SOUTH
Parameters:
biasRet - an array containing the bias that was checked the location within the model that best represents the nextlocation visual position
exception:
BadLocationException -
exception:
IllegalArgumentException - if direction is invalid |
| getRightInset | | protected short getRightInset()(Code) | | Gets the right inset.
the inset >= 0 |
| getTopInset | | protected short getTopInset()(Code) | | Gets the top inset.
the inset >= 0 |
| getView | | public View getView(int n)(Code) | | Returns the n-th view in this container.
Parameters:
n - the number of the desired view, >= 0 && < getViewCount() the view at index n |
| getViewAtPoint | | abstract protected View getViewAtPoint(int x, int y, Rectangle alloc)(Code) | | Fetches the child view at the given coordinates.
Parameters:
x - the X coordinate >= 0
Parameters:
y - the Y coordinate >= 0
Parameters:
alloc - the parent's allocation on entry, which shouldbe changed to the child's allocation on exit the child view |
| getViewAtPosition | | protected View getViewAtPosition(int pos, Rectangle a)(Code) | | Fetches the child view that represents the given position in
the model. This is implemented to fetch the view in the case
where there is a child view for each child element.
Parameters:
pos - the position >= 0
Parameters:
a - the allocation to the interior of the box on entry, and the allocation of the view containing the position on exit the view representing the given position, or null if there isn't one |
| getViewCount | | public int getViewCount()(Code) | | Returns the number of child views of this view.
the number of views >= 0
See Also: CompositeView.getView |
| getViewIndex | | public int getViewIndex(int pos, Position.Bias b)(Code) | | Returns the child view index representing the given
position in the model. This is implemented to call the
getViewIndexByPosition
method for backward compatibility.
Parameters:
pos - the position >= 0 index of the view representing the given position, or -1 if no view represents that position
since:
1.3 |
| getViewIndexAtPosition | | protected int getViewIndexAtPosition(int pos)(Code) | | Fetches the child view index representing the given position in
the model. This is implemented to fetch the view in the case
where there is a child view for each child element.
Parameters:
pos - the position >= 0 index of the view representing the given position, or -1 if no view represents that position |
| isAfter | | abstract protected boolean isAfter(int x, int y, Rectangle alloc)(Code) | | Tests whether a point lies after the rectangle range.
Parameters:
x - the X coordinate >= 0
Parameters:
y - the Y coordinate >= 0
Parameters:
alloc - the rectangle true if the point is after the specified range |
| isBefore | | abstract protected boolean isBefore(int x, int y, Rectangle alloc)(Code) | | Tests whether a point lies before the rectangle range.
Parameters:
x - the X coordinate >= 0
Parameters:
y - the Y coordinate >= 0
Parameters:
alloc - the rectangle true if the point is before the specified range |
| loadChildren | | protected void loadChildren(ViewFactory f)(Code) | | Loads all of the children to initialize the view.
This is called by the
CompositeView.setParent 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.
Parameters:
f - the view factory
See Also: CompositeView.setParent |
| modelToView | | public Shape modelToView(int pos, Shape a, Position.Bias b) throws BadLocationException(Code) | | Provides a mapping from the document model coordinate space
to the coordinate space of the view mapped to it.
Parameters:
pos - the position to convert >= 0
Parameters:
a - the allocated region to render into
Parameters:
b - a bias value of either Position.Bias.Forwardor Position.Bias.Backward the bounding box of the given position
exception:
BadLocationException - if the given position doesnot represent a valid location in the associated document
See Also: View.modelToView |
| modelToView | | public Shape modelToView(int p0, Position.Bias b0, int p1, Position.Bias b1, Shape a) throws BadLocationException(Code) | | Provides a mapping from the document model coordinate space
to the coordinate space of the view mapped to it.
Parameters:
p0 - the position to convert >= 0
Parameters:
b0 - the bias toward the previous character or thenext character represented by p0, in case the position is a boundary of two views; eitherPosition.Bias.Forward orPosition.Bias.Backward
Parameters:
p1 - the position to convert >= 0
Parameters:
b1 - the bias toward the previous character or thenext character represented by p1, in case the position is a boundary of two views
Parameters:
a - the allocated region to render into the bounding box of the given position is returned
exception:
BadLocationException - if the given position doesnot represent a valid location in the associated document
exception:
IllegalArgumentException - for an invalid bias argument
See Also: View.viewToModel |
| replace | | public void replace(int offset, int length, View[] views)(Code) | | Replaces child views. If there are no views to remove
this acts as an insert. If there are no views to
add this acts as a remove. Views being removed will
have the parent set to null,
and the internal reference to them removed so that they
may be garbage collected.
Parameters:
offset - the starting index into the child views to insertthe new views; >= 0 and <= getViewCount
Parameters:
length - the number of existing child views to remove;this should be a value >= 0 and <= (getViewCount() - offset)
Parameters:
views - the child views to add; this value can benullto indicate no children are being added (useful to remove) |
| setInsets | | protected void setInsets(short top, short left, short bottom, short right)(Code) | | Sets the insets for the view.
Parameters:
top - the top inset >= 0
Parameters:
left - the left inset >= 0
Parameters:
bottom - the bottom inset >= 0
Parameters:
right - the right inset >= 0 |
| setParagraphInsets | | protected void setParagraphInsets(AttributeSet attr)(Code) | | Sets the insets from the paragraph attributes specified in
the given attributes.
Parameters:
attr - the attributes |
| setParent | | public void setParent(View parent)(Code) | | Sets the parent of the view.
This is reimplemented to provide the superclass
behavior as well as calling the 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.
Parameters:
parent - the parent of the view, null if none |
| viewToModel | | public int viewToModel(float x, float y, Shape a, Position.Bias[] bias)(Code) | | Provides a mapping from the view coordinate space to the logical
coordinate space of the model.
Parameters:
x - x coordinate of the view location to convert >= 0
Parameters:
y - y coordinate of the view location to convert >= 0
Parameters:
a - the allocated region to render into
Parameters:
bias - either Position.Bias.Forward orPosition.Bias.Backward the location within the model that best represents thegiven point in the view >= 0
See Also: View.viewToModel |
| Methods inherited from javax.swing.text.View | public void append(View v)(Code)(Java Doc)
public View breakView(int axis, int offset, float pos, float len)(Code)(Java Doc)
public void changedUpdate(DocumentEvent e, Shape a, ViewFactory f)(Code)(Java Doc)
public View createFragment(int p0, int p1)(Code)(Java Doc)
protected void forwardUpdate(DocumentEvent.ElementChange ec, DocumentEvent e, Shape a, ViewFactory f)(Code)(Java Doc)
protected void forwardUpdateToView(View v, DocumentEvent e, Shape a, ViewFactory f)(Code)(Java Doc)
public float getAlignment(int axis)(Code)(Java Doc)
public AttributeSet getAttributes()(Code)(Java Doc)
public int getBreakWeight(int axis, float pos, float len)(Code)(Java Doc)
public Shape getChildAllocation(int index, Shape a)(Code)(Java Doc)
public Container getContainer()(Code)(Java Doc)
public Document getDocument()(Code)(Java Doc)
public Element getElement()(Code)(Java Doc)
public int getEndOffset()(Code)(Java Doc)
public Graphics getGraphics()(Code)(Java Doc)
public float getMaximumSpan(int axis)(Code)(Java Doc)
public float getMinimumSpan(int axis)(Code)(Java Doc)
public int getNextVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet) throws BadLocationException(Code)(Java Doc)
public View getParent()(Code)(Java Doc)
abstract public float getPreferredSpan(int axis)(Code)(Java Doc)
public int getResizeWeight(int axis)(Code)(Java Doc)
public int getStartOffset()(Code)(Java Doc)
public String getToolTipText(float x, float y, Shape allocation)(Code)(Java Doc)
public View getView(int n)(Code)(Java Doc)
public int getViewCount()(Code)(Java Doc)
public ViewFactory getViewFactory()(Code)(Java Doc)
public int getViewIndex(int pos, Position.Bias b)(Code)(Java Doc)
public int getViewIndex(float x, float y, Shape allocation)(Code)(Java Doc)
public void insert(int offs, View v)(Code)(Java Doc)
public void insertUpdate(DocumentEvent e, Shape a, ViewFactory f)(Code)(Java Doc)
public boolean isVisible()(Code)(Java Doc)
abstract public Shape modelToView(int pos, Shape a, Position.Bias b) throws BadLocationException(Code)(Java Doc)
public Shape modelToView(int p0, Position.Bias b0, int p1, Position.Bias b1, Shape a) throws BadLocationException(Code)(Java Doc)
public Shape modelToView(int pos, Shape a) throws BadLocationException(Code)(Java Doc)
abstract public void paint(Graphics g, Shape allocation)(Code)(Java Doc)
public void preferenceChanged(View child, boolean width, boolean height)(Code)(Java Doc)
public void remove(int i)(Code)(Java Doc)
public void removeAll()(Code)(Java Doc)
public void removeUpdate(DocumentEvent e, Shape a, ViewFactory f)(Code)(Java Doc)
public void replace(int offset, int length, View[] views)(Code)(Java Doc)
public void setParent(View parent)(Code)(Java Doc)
public void setSize(float width, float height)(Code)(Java Doc)
protected boolean updateChildren(DocumentEvent.ElementChange ec, DocumentEvent e, ViewFactory f)(Code)(Java Doc)
protected void updateLayout(DocumentEvent.ElementChange ec, DocumentEvent e, Shape a)(Code)(Java Doc)
abstract public int viewToModel(float x, float y, Shape a, Position.Bias[] biasReturn)(Code)(Java Doc)
public int viewToModel(float x, float y, Shape a)(Code)(Java Doc)
|
|
|