| Overview | Package | Class | Tree | Deprecated | Index | Help | Legend |
|
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Object
|
+--javax.swing.text.View
|
+--javax.swing.text.CompositeView
Safe: 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
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 Views,
it does allow for inseting the child Views
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
javax.swing.text.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 offseting
the bounds by the Insets of the
CompositeView.
| Field Summary | |
private short |
bottom
|
private Rectangle |
childAlloc
|
private View[] |
children
|
private short |
left
|
private int |
nchildren
|
private short |
right
|
private short |
top
|
private static View[] |
ZERO
|
| Fields inherited from class javax.swing.text.View |
BadBreakWeight, ExcellentBreakWeight, ForcedBreakWeight, GoodBreakWeight, sharedBiasReturn, X_AXIS, Y_AXIS |
| Fields inherited from interface javax.swing.SwingConstants |
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST |
| Constructor Summary | |
CompositeView(Element elem)
Enabled: Constructs a CompositeView for the given element. |
|
| Method Summary | |
protected abstract void |
childAllocation(int index,
Rectangle a)
Returns the allocation for a given child. |
protected boolean |
flipEastAndWestAtEnds(int position,
javax.swing.text.Position.Bias bias)
Determines in which direction the next view lays. |
protected short |
getBottomInset()
Gets the bottom inset. |
Shape |
getChildAllocation(int index,
Shape a)
Enabled: 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,
javax.swing.text.Position.Bias b,
Shape a,
int direction,
javax.swing.text.Position.Bias[] biasRet)
Returns the next visual position for the cursor, in either the east or west direction. |
protected int |
getNextNorthSouthVisualPositionFrom(int pos,
javax.swing.text.Position.Bias b,
Shape a,
int direction,
javax.swing.text.Position.Bias[] biasRet)
Returns the next visual position for the cursor, in either the north or south direction. |
int |
getNextVisualPositionFrom(int pos,
javax.swing.text.Position.Bias b,
Shape a,
int direction,
javax.swing.text.Position.Bias[] biasRet)
Suppressed: 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(int n)
Enabled: Returns the n-th view in this container. |
protected abstract 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. |
int |
getViewCount()
Enabled: Returns the number of child views of this view. |
int |
getViewIndex(int pos,
javax.swing.text.Position.Bias b)
Suppressed: 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. |
protected abstract boolean |
isAfter(int x,
int y,
Rectangle alloc)
Tests whether a point lies after the rectangle range. |
protected abstract 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. |
Shape |
modelToView(int p0,
javax.swing.text.Position.Bias b0,
int p1,
javax.swing.text.Position.Bias b1,
Shape a)
Suppressed: Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it. |
Shape |
modelToView(int pos,
Shape a,
javax.swing.text.Position.Bias b)
Suppressed: Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it. |
void |
replace(int offset,
int length,
View[] views)
Enabled: 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. |
void |
setParent(View parent)
Suppressed: Sets the parent of the view. |
int |
viewToModel(float x,
float y,
Shape a,
javax.swing.text.Position.Bias[] bias)
Suppressed: Provides a mapping from the view coordinate space to the logical coordinate space of the model. |
| Methods inherited from class javax.swing.text.View |
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 |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
private static View[] ZERO
private View[] children
private int nchildren
private short left
private short right
private short top
private short bottom
private Rectangle childAlloc
| Constructor Detail |
public CompositeView(Element elem)
CompositeView for the given element.
elem - the element this view is responsible for| Method Detail |
protected 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 factorysetParent(javax.swing.text.View)public 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.
setParent in class Viewparent - the parent of the view, null if nonepublic int getViewCount()
getViewCount in class ViewgetView(int)public View getView(int n)
getView in class Viewn - the number of the desired view, >= 0 && < getViewCount()
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 Viewlength - 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 Viewindex - the index of the child, >= 0 && < getViewCount()a - the allocation to this view
public Shape modelToView(int pos,
Shape a,
javax.swing.text.Position.Bias b)
throws BadLocationException
modelToView in class Viewpos - the position to convert >= 0a - the allocated region to render intob - a bias value of either Position.Bias.Forward
or Position.Bias.Backward
BadLocationExceptionView.modelToView(int, java.awt.Shape, javax.swing.text.Position.Bias)
public Shape modelToView(int p0,
javax.swing.text.Position.Bias b0,
int p1,
javax.swing.text.Position.Bias b1,
Shape a)
throws BadLocationException
modelToView in class Viewp0 - 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.Backwardp1 - 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 into
BadLocationExceptionView.viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[])
public int viewToModel(float x,
float y,
Shape a,
javax.swing.text.Position.Bias[] bias)
viewToModel in class Viewx - 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
View.viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[])
public int getNextVisualPositionFrom(int pos,
javax.swing.text.Position.Bias b,
Shape a,
int direction,
javax.swing.text.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[]).
getNextVisualPositionFrom in class Viewpos - the position to convert >= 0b - a bias value of either Position.Bias.Forward
or Position.Bias.Backwarda - 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 checked
BadLocationException
public int getViewIndex(int pos,
javax.swing.text.Position.Bias b)
getViewIndexByPosition
method for backward compatibility.
getViewIndex in class Viewpos - the position >= 0
protected abstract boolean isBefore(int x,
int y,
Rectangle alloc)
x - the X coordinate >= 0y - the Y coordinate >= 0alloc - the rectangle
protected abstract boolean isAfter(int x,
int y,
Rectangle alloc)
x - the X coordinate >= 0y - the Y coordinate >= 0alloc - the rectangle
protected 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 exit
protected 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 exit
null if there isn't oneprotected int getViewIndexAtPosition(int pos)
pos - the position >= 0
protected Rectangle getInsideAllocation(Shape a)
childAllocation method.
a - the allocation given to the view
null,
the return value is nullprotected void setParagraphInsets(AttributeSet attr)
attr - the attributes
protected 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,
javax.swing.text.Position.Bias b,
Shape a,
int direction,
javax.swing.text.Position.Bias[] biasRet)
throws BadLocationException
pos - the position to convert >= 0b - a bias value of either Position.Bias.Forward
or Position.Bias.Backwarda - 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 checked
BadLocationExceptiongetNextVisualPositionFrom(int, javax.swing.text.Position.Bias, java.awt.Shape, int, javax.swing.text.Position.Bias[])
protected int getNextEastWestVisualPositionFrom(int pos,
javax.swing.text.Position.Bias b,
Shape a,
int direction,
javax.swing.text.Position.Bias[] biasRet)
throws BadLocationException
pos - the position to convert >= 0b - a bias value of either Position.Bias.Forward
or Position.Bias.Backwarda - 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 checked
BadLocationExceptiongetNextVisualPositionFrom(int, javax.swing.text.Position.Bias, java.awt.Shape, int, javax.swing.text.Position.Bias[])
protected boolean flipEastAndWestAtEnds(int position,
javax.swing.text.Position.Bias bias)
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.
position - position into the modelbias - either Position.Bias.Forward or
Position.Bias.Backward
|
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
