CompositeView JDK 1.6)

Methods

public void append (View v) [Inherited From View]

Appends a single child view.

Appends a single child view. This is a convenience
call to replace.
Parameters:
- v - the view
Since: 1.3
See Also: View.replace(int, int, javax.swing.text.View[]),

public View breakView (int axis, int offset, float pos, float len) [Inherited From View]

Tries to break this view on the given axis.

public void changedUpdate (DocumentEvent e, Shape a, ViewFactory f) [Inherited From View]

Gives notification from the document that attributes were changed in a location that this view is responsible for.

protectedabstract void childAllocation (int index, Rectangle a)

Returns the allocation for a given child.

public View createFragment (int p0, int p1) [Inherited From View]

Creates a view that represents a portion of the element.

protected boolean flipEastAndWestAtEnds (int position, Bias bias)

Determines in which direction the next view lays.

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.
Returns: false
Parameters:
- position - position into the model
- bias - either Position.Bias.Forward or Position.Bias.Backward

protected void forwardUpdate (ElementChange ec, DocumentEvent e, Shape a, ViewFactory f) [Inherited From View]

Forwards the given DocumentEvent to the child views that need to be notified of the change to the model.

Forwards the given DocumentEvent to the child views
that need to be notified of the change to the model.
If there were changes to the element this view is
responsible for, that should be considered when
forwarding (i.e. new child views should not get
notified).
Parameters:
- ec - changes to the element this view is responsible for (may be null if there were no changes).
- e - the change information from the associated document
- a - the current allocation of the view
- f - the factory to use to rebuild if the view has children
Since: 1.3
See Also: View.insertUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory), View.removeUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory), View.changedUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory),

protected void forwardUpdateToView (View v, DocumentEvent e, Shape a, ViewFactory f) [Inherited From View]

Forwards the DocumentEvent to the give child view.

Forwards the DocumentEvent to the give child view. This
simply messages the view with a call to insertUpdate,
removeUpdate, or changedUpdate depending
upon the type of the event. This is called by
forwardUpdate to forward
the event to children that need it.
Parameters:
- v - the child view to forward the event to
- e - the change information from the associated document
- a - the current allocation of the view
- f - the factory to use to rebuild if the view has children
Since: 1.3
See Also:

View.forwardUpdate(javax.swing.event.DocumentEvent.ElementChange, javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory)

public float getAlignment (int axis) [Inherited From View]

Determines the desired alignment for this view along an axis.

Determines the desired alignment for this view along an
axis. The desired alignment is returned. This should be
a value >= 0.0 and <= 1.0, where 0 indicates alignment at
the origin and 1.0 indicates alignment to the full span
away from the origin. An alignment of 0.5 would be the
center of the view.
Returns: the value 0.5
Parameters:
- axis - may be either View.X_AXIS or View.Y_AXIS

public AttributeSet getAttributes () [Inherited From View]

Fetches the attributes to use when rendering.

Fetches the attributes to use when rendering. By default
this simply returns the attributes of the associated element.
This method should be used rather than using the element
directly to obtain access to the attributes to allow
view-specific attributes to be mixed in or to allow the
view to have view-specific conversion of attributes by
subclasses.
Each view should document what attributes it recognizes
for the purpose of rendering or layout, and should always
access them through the AttributeSet returned
by this method.

protected short getBottomInset ()

Gets the bottom inset.

public int getBreakWeight (int axis, float pos, float len) [Inherited From View]

Determines how attractive a break opportunity in this view is.

Determines how attractive a break opportunity in this view is. This can be used for determining which view is the most attractive to call breakView on in the process of formatting. A view that represents text that has whitespace in it might be more attractive than a view that has no whitespace, for example. The higher the weight, the more attractive the break. A value equal to or lower than BadBreakWeight should not be considered for a break. A value greater than or equal to ForcedBreakWeight should be broken.

This is implemented to provide the default behavior of returning BadBreakWeight unless the length is greater than the length of the view in which case the entire view represents the fragment. Unless a view has been written to support breaking behavior, it is not attractive to try and break the view. An example of a view that does support breaking is LabelView. An example of a view that uses break weight is ParagraphView.
Returns: the weight, which should be a value between ForcedBreakWeight and BadBreakWeight
Parameters:
- axis - may be either View.X_AXIS or View.Y_AXIS
- pos - the potential location of the start of the broken view >= 0. This may be useful for calculating tab positions
- len - specifies the relative length from pos where a potential break is desired >= 0
See Also: LabelView, ParagraphView, View.BadBreakWeight, View.GoodBreakWeight, View.ExcellentBreakWeight, View.ForcedBreakWeight,

public Shape getChildAllocation (int index, Shape a) [Overrides View]

Fetches the allocation for the given child view to render into.

public Container getContainer () [Inherited From View]

Fetches the container hosting the view.

Fetches the container hosting the view. This is useful for
things like scheduling a repaint, finding out the host
components font, etc. The default implementation
of this is to forward the query to the parent view.
Returns: the container, null if none

public Document getDocument () [Inherited From View]

Fetches the model associated with the view.

Fetches the model associated with the view.
Returns: the view model, null if none
See Also: View.getDocument(),

public Element getElement () [Inherited From View]

Fetches the structural portion of the subject that this view is mapped to.

public int getEndOffset () [Inherited From View]

Fetches the portion of the model for which this view is responsible.

public Graphics getGraphics () [Inherited From View]

Fetch a Graphics for rendering.

Fetch a Graphics for rendering.
This can be used to determine
font characteristics, and will be different for a print view
than a component view.
Returns: a Graphics object for rendering
Since: 1.3

protected Rectangle getInsideAllocation (Shape a)

Translates the immutable allocation given to the view to a mutable allocation that represents the interior allocation (i.e.

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.
Returns: the allocation that represents the inside of the view after the margins have all been removed; if the given allocation was null, the return value is null
Parameters:
- a - the allocation given to the view

protected short getLeftInset ()

Gets the left inset.

public float getMaximumSpan (int axis) [Inherited From View]

Determines the maximum span for this view along an axis.

Determines the maximum span for this view along an
axis.
Returns: the maximum span the view can be rendered into
Parameters:
- axis - may be either View.X_AXIS or View.Y_AXIS
See Also: View.getPreferredSpan(int),

public float getMinimumSpan (int axis) [Inherited From View]

Determines the minimum span for this view along an axis.

Determines the minimum span for this view along an
axis.
Returns: the minimum span the view can be rendered into
Parameters:
- axis - may be either View.X_AXIS or View.Y_AXIS
See Also: View.getPreferredSpan(int),

protected int getNextEastWestVisualPositionFrom (int pos, Bias b, Shape a, int direction, Bias biasRet) throws BadLocationException

Returns the next visual position for the cursor, in either the east or west direction.

Returns the next visual position for the cursor, in either the
east or west direction.
Returns: the location within the model that best represents the next west or east location
Parameters:
- pos - the position to convert >= 0
- b - a bias value of either Position.Bias.Forward or Position.Bias.Backward
- a - the allocated region to render into
- direction - 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
Throws:
- BadLocationException -
- IllegalArgumentException - if direction is invalid
See Also:

CompositeView.getNextVisualPositionFrom(int, javax.swing.text.Position.Bias, java.awt.Shape, int, javax.swing.text.Position.Bias[])

protected int getNextNorthSouthVisualPositionFrom (int pos, Bias b, Shape a, int direction, Bias biasRet) throws BadLocationException

Returns the next visual position for the cursor, in either the north or south direction.

Returns the next visual position for the cursor, in either the
north or south direction.
Returns: the location within the model that best represents the next north or south location the next position west of the passed in position
Parameters:
- pos - the position to convert >= 0
- b - a bias value of either Position.Bias.Forward or Position.Bias.Backward
- a - the allocated region to render into
- direction - 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
Throws:
- BadLocationException -
- IllegalArgumentException - if direction is invalid
See Also:

CompositeView.getNextVisualPositionFrom(int, javax.swing.text.Position.Bias, java.awt.Shape, int, javax.swing.text.Position.Bias[])

public int getNextVisualPositionFrom (int pos, Bias b, Shape a, int direction, Bias biasRet) throws BadLocationException [Overrides View]

Provides a way to determine the next visually represented model location that one might place a caret.

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(int, javax.swing.text.Position.Bias, java.awt.Shape, int, javax.swing.text.Position.Bias[])

and

CompositeView.getNextEastWestVisualPositionFrom(int, javax.swing.text.Position.Bias, java.awt.Shape, int, javax.swing.text.Position.Bias[])

.
Returns: the location within the model that best represents the next location visual position
Parameters:
- pos - the position to convert >= 0
- b - a bias value of either Position.Bias.Forward or Position.Bias.Backward
- a - the allocated region to render into
- direction - 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
Throws:
- BadLocationException -
- IllegalArgumentException - if direction is invalid

public View getParent () [Inherited From View]

Returns the parent of the view.

Returns the parent of the view.
Returns: the parent, or null if none exists

publicabstract float getPreferredSpan (int axis) [Inherited From View]

Determines the preferred span for this view along an axis.

Determines the preferred span for this view along an
axis.
Returns: the span the view would like to be rendered into. Typically the view is told to render into the span that is returned, although there is no guarantee. The parent may choose to resize or break the view
Parameters:
- axis - may be either View.X_AXIS or View.Y_AXIS
See Also: View.getPreferredSpan(int),

public int getResizeWeight (int axis) [Inherited From View]

Determines the resizability of the view along the given axis.

Determines the resizability of the view along the
given axis. A value of 0 or less is not resizable.
Returns: the weight
Parameters:
- axis - may be either View.X_AXIS or View.Y_AXIS

protected short getRightInset ()

Gets the right inset.

public int getStartOffset () [Inherited From View]

Fetches the portion of the model for which this view is responsible.

public String getToolTipText (float x, float y, Shape allocation) [Inherited From View]

Returns the tooltip text at the specified location.

protected short getTopInset ()

Gets the top inset.

public View getView (int n) [Overrides View]

Returns the n-th view in this container.

Returns the n-th view in this container.
Returns: the view at index n
Parameters:
- n - the number of the desired view, >= 0 && < getViewCount()

protectedabstract 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.

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.
Returns: the view representing the given position, or null if there isn't one
Parameters:
- pos - the position >= 0
- a - the allocation to the interior of the box on entry, and the allocation of the view containing the position on exit

public int getViewCount () [Overrides View]

Returns the number of child views of this view.

public ViewFactory getViewFactory () [Inherited From View]

Fetches the ViewFactory implementation that is feeding the view hierarchy.

Fetches the ViewFactory implementation that is feeding
the view hierarchy. Normally the views are given this
as an argument to updates from the model when they
are most likely to need the factory, but this
method serves to provide it at other times.
Returns: the factory, null if none

public int getViewIndex (float x, float y, Shape allocation) [Inherited From View]

Returns the child view index representing the given position in the view.

Returns the child view index representing the given position in
the view. This iterates over all the children returning the
first with a bounds that contains x, y.
Returns: index of the view representing the given location, or -1 if no view represents that position
Parameters:
- x - the x coordinate
- y - the y coordinate
- allocation - current allocation of the View.
Since: 1.4

public int getViewIndex (int pos, Bias b) [Overrides View]

Returns the child view index representing the given position in the model.

Returns the child view index representing the given
position in the model. This is implemented to call the
getViewIndexByPosition
method for backward compatibility.
Returns: index of the view representing the given position, or -1 if no view represents that position
Parameters:
- pos - the position >= 0
Since: 1.3

protected int getViewIndexAtPosition (int pos)

Fetches the child view index representing the given position in the model.

public void insert (int offs, View v) [Inherited From View]

Inserts a single child view.

Inserts a single child view. This is a convenience
call to replace.
Parameters:
- offs - the offset of the view to insert before >= 0
- v - the view
Since: 1.3
See Also: View.replace(int, int, javax.swing.text.View[]),

public void insertUpdate (DocumentEvent e, Shape a, ViewFactory f) [Inherited From View]

Gives notification that something was inserted into the document in a location that this view is responsible for.

protectedabstract boolean isAfter (int x, int y, Rectangle alloc)

Tests whether a point lies after the rectangle range.

protectedabstract boolean isBefore (int x, int y, Rectangle alloc)

Tests whether a point lies before the rectangle range.

public boolean isVisible () [Inherited From View]

Returns a boolean that indicates whether the view is visible or not.

protected void loadChildren (ViewFactory f)

Loads all of the children to initialize the view.

public Shape modelToView (int p0, Bias b0, int p1, Bias b1, Shape a) throws BadLocationException [Overrides View]

Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it.

Provides a mapping from the document model coordinate space
to the coordinate space of the view mapped to it.
Returns: the bounding box of the given position is returned
Parameters:
- p0 - the position to convert >= 0
- b0 - 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 >= 0
- b1 - 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 into
Throws:
- BadLocationException - if the given position does not represent a valid location in the associated document
- IllegalArgumentException - for an invalid bias argument
See Also: View.viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[]),

@Deprecated

public Shape ~~modelToView~~ (int pos, Shape a) throws BadLocationException [Inherited From View]

Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it.

Provides a mapping from the document model coordinate space
to the coordinate space of the view mapped to it. This is
implemented to default the bias to Position.Bias.Forward
which was previously implied.
Returns: the bounding box of the given position is returned
Parameters:
- pos - the position to convert >= 0
- a - the allocated region in which to render
Throws:
- BadLocationException - if the given position does not represent a valid location in the associated document
See Also: View.modelToView(int, java.awt.Shape, javax.swing.text.Position.Bias),

public Shape modelToView (int pos, Shape a, Bias b) throws BadLocationException [Specified in View]

Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it.

Provides a mapping from the document model coordinate space
to the coordinate space of the view mapped to it.
Returns: the bounding box of the given position
Parameters:
- pos - the position to convert >= 0
- a - the allocated region to render into
- b - a bias value of either Position.Bias.Forward or Position.Bias.Backward
Throws:
- BadLocationException - if the given position does not represent a valid location in the associated document
See Also: View.modelToView(int, java.awt.Shape, javax.swing.text.Position.Bias),

publicabstract void paint (Graphics g, Shape allocation) [Inherited From View]

Renders using the given rendering surface and area on that surface.

public void preferenceChanged (View child, boolean width, boolean height) [Inherited From View]

Child views can call this on the parent to indicate that the preference has changed and should be reconsidered for layout.

Child views can call this on the parent to indicate that
the preference has changed and should be reconsidered
for layout. By default this just propagates upward to
the next parent. The root view will call
revalidate on the associated text component.
Parameters:
- child - the child view
- width - true if the width preference has changed
- height - true if the height preference has changed
See Also: JComponent.revalidate(),

public void remove (int i) [Inherited From View]

Removes one of the children at the given position.

Removes one of the children at the given position.
This is a convenience call to replace.
Since: 1.3

public void removeAll () [Inherited From View]

Removes all of the children.

Removes all of the children. This is a convenience
call to replace.
Since: 1.3

public void removeUpdate (DocumentEvent e, Shape a, ViewFactory f) [Inherited From View]

Gives notification that something was removed from the document in a location that this view is responsible for.

public void replace (int offset, int length, View views) [Overrides View]

Replaces child views.

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 insert the new views; >= 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)

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) [Overrides View]

Sets the parent of the view.

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

public void setSize (float width, float height) [Inherited From View]

Sets the size of the view.

protected boolean updateChildren (ElementChange ec, DocumentEvent e, ViewFactory f) [Inherited From View]

Updates the child views in response to receiving notification that the model changed, and there is change record for the element this view is responsible for.

Updates the child views in response to receiving notification
that the model changed, and there is change record for the
element this view is responsible for. This is implemented
to assume the child views are directly responsible for the
child elements of the element this view represents. The
ViewFactory is used to create child views for each element
specified as added in the ElementChange, starting at the
index specified in the given ElementChange. The number of
child views representing the removed elements specified are
removed.
Returns: whether or not the child views represent the child elements of the element this view is responsible for. Some views create children that represent a portion of the element they are responsible for, and should return false. This information is used to determine if views in the range of the added elements should be forwarded to or not
Parameters:
- ec - the change information for the element this view is responsible for. This should not be null if this method gets called
- e - the change information from the associated document
- f - the factory to use to build child views
Since: 1.3
See Also: View.insertUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory), View.removeUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory), View.changedUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory),

protected void updateLayout (ElementChange ec, DocumentEvent e, Shape a) [Inherited From View]

Updates the layout in response to receiving notification of change from the model.

Updates the layout in response to receiving notification of
change from the model. This is implemented to call
preferenceChanged to reschedule a new layout
if the ElementChange record is not null.
Parameters:
- ec - changes to the element this view is responsible for (may be null if there were no changes)
- e - the change information from the associated document
- a - the current allocation of the view
Since: 1.3
See Also: View.insertUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory), View.removeUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory), View.changedUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory),

@Deprecated

public int ~~viewToModel~~ (float x, float y, Shape a) [Inherited From View]

Provides a mapping from the view coordinate space to the logical coordinate space of the model.

public int viewToModel (float x, float y, Shape a, Bias bias) [Specified in View]

Provides a mapping from the view coordinate space to the logical coordinate space of the model.

Provides a mapping from the view coordinate space to the logical
coordinate space of the model.
Returns: the location within the model that best represents the given point in the view >= 0
Parameters:
- x - x coordinate of the view location to convert >= 0
- y - y coordinate of the view location to convert >= 0
- a - the allocated region to render into
- bias - either Position.Bias.Forward or Position.Bias.Backward
See Also: View.viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[]),