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[]),

  Tries to break this view on the given axis.

  Tries to break this view on the given axis. This is called by views that try to do formatting of their children. For example, a view of a paragraph will typically try to place its children into row and views representing chunks of text can sometimes be broken down into smaller pieces.

This is implemented to return the view itself, which represents the default behavior on not being breakable. If the view does support breaking, the starting offset of the view returned should be the given offset, and the end offset should be less than or equal to the end offset of the view being broken.
Returns: the fragment of the view that represents the given span, if the view can be broken. If the view doesn't support breaking behavior, the view itself is returned.
Parameters:
- axis - may be either View.X_AXIS or View.Y_AXIS
- offset - the location in the document model that a broken fragment would occupy >= 0. This would be the starting offset of the fragment returned
- pos - the position along the axis that the broken view would occupy >= 0. This may be useful for things like tab calculations
- len - specifies the distance along the axis where a potential break is desired >= 0
See Also: ParagraphView,

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

  Gives notification from the document that attributes were changed
in a location that this view is responsible for.
To reduce the burden to subclasses, this functionality is
spread out into the following calls that subclasses can
reimplement:

1. updateChildren is called
   if there were any changes to the element this view is
   responsible for. If this view has child views that are
   represent the child elements, then this method should do
   whatever is necessary to make sure the child views correctly
   represent the model.
   
2. forwardUpdate is called
   to forward the DocumentEvent to the appropriate child views.
   
3. updateLayout is called to
   give the view a chance to either repair its layout, to reschedule
   layout, or do nothing.
   

Parameters:
- 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
See Also: View.changedUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory),

  Creates a view that represents a portion of the element.

  Creates a view that represents a portion of the element.
This is potentially useful during formatting operations
for taking measurements of fragments of the view. If
the view doesn't support fragmenting (the default), it
should return itself.
Returns: the view fragment, or itself if the view doesn't support breaking into fragments
Parameters:
- p0 - the starting offset >= 0. This should be a value greater or equal to the element starting offset and less than the element ending offset.
- p1 - the ending offset > p0. This should be a value less than or equal to the elements end offset and greater than the elements starting offset.
See Also: LabelView,

  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),

  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.

  Gets the bottom inset.

  Gets the bottom inset.
Returns: the inset >= 0

  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,

  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

  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(),

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

  Fetches the structural portion of the subject that this
view is mapped to. The view may not be responsible for the
entire portion of the element.
Returns: the subject
See Also: View.getElement(),

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

  Fetches the portion of the model for which this view is
responsible.
Returns: the ending offset into the model >= 0
See Also: View.getEndOffset(),

  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

  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

  Gets the left inset.

  Gets the left inset.
Returns: the inset >= 0

  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[]),

  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[]),

  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

  Returns the parent of the view.

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

  Gets the right inset.

  Gets the right inset.
Returns: the inset >= 0

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

  Fetches the portion of the model for which this view is
responsible.
Returns: the starting offset into the model >= 0
See Also: View.getStartOffset(),

  Returns the tooltip text at the specified location.

  Returns the tooltip text at the specified location. The default
implementation returns the value from the child View identified by
the passed in location.
Since: 1.4
See Also: JTextComponent.getToolTipText(java.awt.event.MouseEvent),

  Gets the top inset.

  Gets the top inset.
Returns: the inset >= 0

  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()

  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

  Returns the number of child views of this view.

  Returns the number of child views of this view.
Returns: the number of views >= 0
See Also: CompositeView.getView(int),

  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

  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

  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

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

  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.
Returns: index of the view representing the given position, or -1 if no view represents that position
Parameters:
- pos - the position >= 0

  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[]),

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

  Gives notification that something was inserted into
the document in a location that this view is responsible for.
To reduce the burden to subclasses, this functionality is
spread out into the following calls that subclasses can
reimplement:

1. updateChildren is called
   if there were any changes to the element this view is
   responsible for. If this view has child views that are
   represent the child elements, then this method should do
   whatever is necessary to make sure the child views correctly
   represent the model.
   
2. forwardUpdate is called
   to forward the DocumentEvent to the appropriate child views.
   
3. updateLayout is called to
   give the view a chance to either repair its layout, to reschedule
   layout, or do nothing.
   

Parameters:
- 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
See Also: View.insertUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory),

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

  Returns a boolean that indicates whether
the view is visible or not. By default
all views are visible.
Returns: always returns true

  Loads all of the children to initialize the view.

  Loads all of the children to initialize the view.
This is called by the CompositeView.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.
Parameters:
- f - the view factory
See Also: CompositeView.setParent(javax.swing.text.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[]),

  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),

  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

  Removes all of the children.

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

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

  Gives notification that something was removed from the document
in a location that this view is responsible for.
To reduce the burden to subclasses, this functionality is
spread out into the following calls that subclasses can
reimplement:

1. updateChildren is called
   if there were any changes to the element this view is
   responsible for. If this view has child views that are
   represent the child elements, then this method should do
   whatever is necessary to make sure the child views correctly
   represent the model.
   
2. forwardUpdate is called
   to forward the DocumentEvent to the appropriate child views.
   
3. updateLayout is called to
   give the view a chance to either repair its layout, to reschedule
   layout, or do nothing.
   

Parameters:
- 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
See Also: View.removeUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory),

  Sets the insets for the view.

  Sets the insets for the view.
Parameters:
- top - the top inset >= 0
- left - the left inset >= 0
- bottom - the bottom inset >= 0
- right - the right inset >= 0

  Sets the insets from the paragraph attributes specified in the given attributes.

  Sets the insets from the paragraph attributes specified in
the given attributes.
Parameters:
- attr - the attributes

  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

  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),

  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),

  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 - the X coordinate >= 0
- y - the Y coordinate >= 0
- a - the allocated region in which to render
See Also: View.viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[]),