|
JavaTM 2 Platform Std. Ed. v1.3 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--javax.swing.text.View | +--javax.swing.text.CompositeView
A view that is composed of other views (has children). As a container of children, the composite view needs to provide:
Fields inherited from class javax.swing.text.View |
BadBreakWeight, ExcellentBreakWeight, ForcedBreakWeight, GoodBreakWeight, X_AXIS, Y_AXIS |
Fields inherited from interface javax.swing.SwingConstants |
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NORTH, NORTH_EAST, NORTH_WEST, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST |
Constructor Summary | |
CompositeView(Element elem)
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,
Position.Bias bias)
Subclasses may wish to subclass this and conditionally return true based on the position. |
protected short |
getBottomInset()
Gets the bottom inset. |
Shape |
getChildAllocation(int index,
Shape a)
Fetches the allocation for the given child view. |
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 east or west direction. |
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. |
View |
getView(int n)
Gets the n-th view in this container. |
protected abstract View |
getViewAtPoint(int x,
int y,
Rectangle alloc)
Fetches the child view at the given point. |
protected View |
getViewAtPosition(int pos,
Rectangle a)
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(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. |
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,
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. |
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. |
void |
replace(int offset,
int length,
View[] views)
Replace 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)
Sets the parent of the view. |
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. |
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, getViewFactory, 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 |
Constructor Detail |
public CompositeView(Element elem)
elem
- the element this view is responsible forMethod Detail |
protected void loadChildren(ViewFactory f)
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 View
parent
- the parent of the view, null if nonepublic int getViewCount()
getViewCount
in class View
getView(int)
public View getView(int n)
getView
in class View
n
- the number of the view to get, >= 0 && < getViewCount()public void replace(int offset, int length, View[] views)
replace
in class View
index
- the starting index into the child views to insert
the new views. This should be a value >= 0 and <= getViewCount.length
- 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 view.public 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 intoBadLocationException
- if the given position does
not represent a valid location in the associated documentView.modelToView(int, java.awt.Shape, javax.swing.text.Position.Bias)
public 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.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 views.a
- the allocated region to render intoBadLocationException
- if the given position does
not represent a valid location in the associated documentIllegalArgumentException
- for an invalid bias argumentView.viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[])
public 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 intoView.viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[])
public int getNextVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet) throws BadLocationException
getNextVisualPositionFrom
in class View
pos
- the position to convert >= 0a
- 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 SwingConstants.WEST, SwingConstants.EAST,
SwingConstants.NORTH, or SwingConstants.SOUTH.BadLocationException
- IllegalArgumentException
- for an invalid directionpublic int getViewIndex(int pos, Position.Bias b)
getViewIndex
in class View
pos
- the position >= 0protected 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 exitprotected int getViewIndexAtPosition(int pos)
pos
- the position >= 0protected Rectangle getInsideAllocation(Shape a)
a
- The allocation given to the view.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
protected int getNextEastWestVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet) throws BadLocationException
protected boolean flipEastAndWestAtEnds(int position, Position.Bias bias)
|
JavaTM 2 Platform Std. Ed. v1.3 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Java, Java 2D, and JDBC are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-2000 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.