ParagraphView JDK 1.6)

Methods

Hide/Show inherited methods

protected void adjustRow (Row r, int desiredSpan, int x)

Adjusts the given row if possible to fit within the layout span.

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

protected void baselineLayout (int targetSpan, int axis, int[] offsets, int[] spans) [Inherited From BoxView]

Computes the location and extent of each child view in this BoxView given the targetSpan, which is the width (or height) of the region we have to work with.

Computes the location and extent of each child view
in this BoxView given the targetSpan,
which is the width (or height) of the region we have to
work with.
Parameters:
- targetSpan - the total span given to the view, which would be used to layout the children
- axis - the axis being studied, either View.X_AXIS or View.Y_AXIS
- offsets - an empty array filled by this method with values specifying the location of each child view
- spans - an empty array filled by this method with values specifying the extent of each child view

protected SizeRequirements baselineRequirements (int axis, SizeRequirements r) [Inherited From BoxView]

Calculates the size requirements for this BoxView by examining the size of each child view.

Calculates the size requirements for this BoxView
by examining the size of each child view.
Returns: the newly initialized SizeRequirements object
Parameters:
- axis - the axis being studied
- r - the SizeRequirements object; if null one will be created

public View breakView (int axis, float len, Shape a)

Breaks this view on the given axis at the given length.

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

Tries to break this view on the given axis.

protected SizeRequirements calculateMajorAxisRequirements (int axis, SizeRequirements r) [Inherited From BoxView]

Calculates the size requirements for the major axis axis.

Calculates the size requirements for the major axis
axis.
Returns: the newly initialized SizeRequirements object
Parameters:
- axis - the axis being studied
- r - the SizeRequirements object; if null one will be created
See Also: SizeRequirements,

protected SizeRequirements calculateMinorAxisRequirements (int axis, SizeRequirements r) [Inherited From FlowView]

Calculate equirements along the minor axis.

public void changedUpdate (DocumentEvent changes, Shape a, ViewFactory f) [Overrides FlowView]

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

pack-private void checkRequests (int axis) [Inherited From BoxView]

Checks the request cache and update if needed.

Checks the request cache and update if needed.
Parameters:
- axis - the axis being studied
Throws:
- IllegalArgumentException - if axis is neither View.X_AXIS nor View.Y_AXIS

protected void childAllocation (int index, Rectangle alloc) [Inherited From BoxView] [Specified in CompositeView]

Allocates a region for a child view.

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

Creates a view that represents a portion of the element.

protected View createRow () [Specified in FlowView]

Create a View that should be used to hold a a row's worth of children in a flow.

Create a View that should be used to hold a
a row's worth of children in a flow.
Returns: the new View
Since: 1.3

protected int findOffsetToCharactersInString (char[] string, int start)

Finds the next character in the document with a character in string, starting at offset start.

Finds the next character in the document with a character in
string, starting at offset start. If
there are no characters found, -1 will be returned.
Returns: the document offset, or -1 if no characters found
Parameters:
- string - the string of characters
- start - where to start in the model >= 0

protected boolean flipEastAndWestAtEnds (int position, Bias bias) [Overrides BoxView]

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 will return true if the text is layed out right to left at position, otherwise false.
Returns: true if the text is layed out right to left at position, otherwise 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 BoxView]

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 a child changed its requirements and the allocation
was valid prior to forwarding the portion of the box
from the starting child to the end of the box will
be repainted.
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) [Overrides BoxView]

Determines the desired alignment for this view along an axis.

Determines the desired alignment for this view along an
axis. This is implemented to give the alignment to the
center of the first row along the y axis, and the default
along the x axis.
Returns: the desired alignment. This should be a value between 0.0 and 1.0 inclusive, 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.
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.

public int getAxis () [Inherited From BoxView]

Fetches the tile axis property.

Fetches the tile axis property. This is the axis along which
the child views are tiled.
Returns: the major axis of the box, either View.X_AXIS or View.Y_AXIS
Since: 1.3

protected short getBottomInset () [Inherited From CompositeView]

Gets the bottom inset.

public int getBreakWeight (int axis, float len)

Gets the break weight for a given location.

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) [Inherited From BoxView]

Fetches the allocation for the given child view.

Fetches the allocation for the given child view.
This enables finding out where various views
are located. This is implemented to return
null if the layout is invalid,
otherwise the superclass behavior is executed.
Returns: the allocation to the child; or null if a is null; or null if the layout is invalid
Parameters:
- index - the index of the child, >= 0 && < getViewCount()
- a - the allocation to this view

protected int getClosestPositionTo (int pos, Bias b, Shape a, int direction, Bias biasRet, int rowIndex, int x) throws BadLocationException

Returns the closest model position to x.

Returns the closest model position to x.
rowIndex gives the index of the view that corresponds
that should be looked in.
Returns: the closest model position to x
Parameters:
- pos - position into the model
- a - the allocated region to render into
- direction - one of the following values:

SwingConstants.NORTH
SwingConstants.SOUTH

- biasRet - an array containing the bias that were checked in this method
- rowIndex - the index of the view
- x - the x coordinate of interest

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 int getFlowAxis () [Inherited From FlowView]

Fetches the axis along which views should be flowed.

Fetches the axis along which views should be
flowed. By default, this will be the axis
orthogonal to the axis along which the flow
rows are tiled (the axis of the default flow
rows themselves). This is typically used
by the FlowStrategy.

public int getFlowSpan (int index) [Overrides FlowView]

Fetches the constraining span to flow against for the given child index.

Fetches the constraining span to flow against for
the given child index.
Returns: the constraining span for the given view at index
Parameters:
- index - the index of the view being queried
Since: 1.3

public int getFlowStart (int index) [Overrides FlowView]

Fetches the location along the flow axis that the flow span will start at.

Fetches the location along the flow axis that the
flow span will start at.
Returns: the location for the given view at index
Parameters:
- index - the index of the view being queried
Since: 1.3

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

public int getHeight () [Inherited From BoxView]

Returns the current height of the box.

protected Rectangle getInsideAllocation (Shape a) [Inherited From CompositeView]

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 View getLayoutView (int index)

Returns the view at a given index.

Returns the view at a given index.
The child views of the paragraph are rows which
have been used to arrange pieces of the Views
that represent the child elements. This methods returns
the view responsible for the child element index
(prior to breaking). These are the Views that were
produced from a factory (to represent the child
elements) and used for layout.
Returns: the view at index
Parameters:
- index - the index of the desired view

protected int getLayoutViewCount ()

Returns the number of views that this view is responsible for.

Returns the number of views that this view is
responsible for.
The child views of the paragraph are rows which
have been used to arrange pieces of the Views
that represent the child elements. This is the number
of views that have been tiled in two dimensions,
and should be equivalent to the number of child elements
to the element this view is responsible for.
Returns: the number of views that this ParagraphView is responsible for

protected short getLeftInset () [Inherited From CompositeView]

Gets the left inset.

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

Determines the maximum span for this view along an axis.

Determines the maximum span for this view along an
axis.
Returns: the span the view would like to be rendered into >= 0; 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
Throws:
- IllegalArgumentException - for an invalid axis type

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

Determines the minimum span for this view along an axis.

Determines the minimum span for this view along an
axis.
Returns: the span the view would like to be rendered into >= 0; 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
Throws:
- IllegalArgumentException - for an invalid axis type

protected int getNextEastWestVisualPositionFrom (int pos, Bias b, Shape a, int direction, Bias biasRet) throws BadLocationException [Inherited From CompositeView]

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 [Overrides CompositeView]

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.
Overridden from CompositeView.
Returns: the location in the model that represents the next location visual position
Parameters:
- pos - position into the model
- b - either Position.Bias.Forward or Position.Bias.Backward
- a - the allocated region to render into
- direction - either SwingConstants.NORTH or SwingConstants.SOUTH
- biasRet - an array containing the bias that were checked in this method

public int getNextVisualPositionFrom (int pos, Bias b, Shape a, int direction, Bias biasRet) throws BadLocationException [Inherited From CompositeView]

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

protected int getOffset (int axis, int childIndex) [Inherited From BoxView]

Fetches the offset of a particular child's current layout.

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

protected float getPartialSize (int startOffset, int endOffset)

Returns the size used by the views between startOffset and endOffset.

Returns the size used by the views between
startOffset and endOffset.
This uses getPartialView to calculate the
size if the child view implements the
TabableView interface. If a
size is needed and a View does not implement
the TabableView interface,
the preferredSpan will be used.
Returns: the size >= 0
Parameters:
- startOffset - the starting document offset >= 0
- endOffset - the ending document offset >= startOffset

public float getPreferredSpan (int axis) [Inherited From BoxView] [Specified in 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 >= 0; 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
Throws:
- IllegalArgumentException - for an invalid axis type

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

Gets the resize weight.

Gets the resize weight. A value of 0 or less is not resizable.
Returns: the weight
Parameters:
- axis - may be either View.X_AXIS or View.Y_AXIS
Throws:
- IllegalArgumentException - for an invalid axis

protected short getRightInset () [Inherited From CompositeView]

Gets the right inset.

protected int getSpan (int axis, int childIndex) [Inherited From BoxView]

Fetches the span of a particular childs current layout.

pack-private float getSpanOnAxis (int axis) [Inherited From BoxView]

Returns the size of the view along an axis.

Returns the size of the view along an axis. This is implemented
to return zero.
Returns: the current span of the view along the given axis, >= 0
Parameters:
- axis - may be either View.X_AXIS or View.Y_AXIS

public int getStartOffset () [Inherited From View]

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

protected float getTabBase ()

Returns where the tabs are calculated from.

protected TabSet getTabSet ()

Gets the Tabset to be used in calculating tabs.

Gets the Tabset to be used in calculating tabs.
Returns: the TabSet

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

Returns the tooltip text at the specified location.

protected short getTopInset () [Inherited From CompositeView]

Gets the top inset.

public View getView (int n) [Inherited From CompositeView]

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

protected View getViewAtPoint (int x, int y, Rectangle alloc) [Inherited From BoxView] [Specified in CompositeView]

Fetches the child view at the given coordinates.

protected View getViewAtPosition (int pos, Rectangle a) [Inherited From CompositeView]

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 () [Inherited From CompositeView]

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) [Inherited From CompositeView]

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) [Inherited From FlowView]

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

public int getWidth () [Inherited From BoxView]

Returns the current width of the box.

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 changes, Shape a, ViewFactory f) [Inherited From FlowView]

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

protected boolean isAfter (int x, int y, Rectangle innerAlloc) [Inherited From BoxView] [Specified in CompositeView]

Determines if a point falls after an allocated region.

protected boolean isAllocationValid () [Inherited From BoxView]

Are the allocations for the children still valid?

protected boolean isBefore (int x, int y, Rectangle innerAlloc) [Inherited From BoxView] [Specified in CompositeView]

Determines if a point falls before an allocated region.

protected boolean isLayoutValid (int axis) [Inherited From BoxView]

Determines if the layout is valid along the given axis.

Determines if the layout is valid along the given axis.
Parameters:
- axis - either View.X_AXIS or View.Y_AXIS
Since: 1.4

public boolean isVisible () [Inherited From View]

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

protected void layout (int width, int height) [Inherited From FlowView]

Lays out the children.

public void layoutChanged (int axis) [Inherited From BoxView]

Invalidates the layout along an axis.

Invalidates the layout along an axis. This happens
automatically if the preferences have changed for
any of the child views. In some cases the layout
may need to be recalculated when the preferences
have not changed. The layout can be marked as
invalid by calling this method. The layout will
be updated the next time the setSize method
is called on this view (typically in paint).
Parameters:
- axis - either View.X_AXIS or View.Y_AXIS
Since: 1.3

protected void layoutMajorAxis (int targetSpan, int axis, int[] offsets, int[] spans) [Inherited From BoxView]

Performs layout for the major axis of the box (i.e.

protected void layoutMinorAxis (int targetSpan, int axis, int[] offsets, int[] spans) [Inherited From BoxView]

Performs layout for the minor axis of the box (i.e.

protected void loadChildren (ViewFactory f) [Inherited From FlowView]

Loads all of the children to initialize the view.

Loads all of the children to initialize the view.
This is called by the setParent method.
This is reimplemented to not load any children directly
(as they are created in the process of formatting).
If the layoutPool variable is null, an instance of
LogicalView is created to represent the logical view
that is used in the process of formatting.
Parameters:
- f - the view factory

public Shape modelToView (int p0, Bias b0, int p1, Bias b1, Shape a) throws BadLocationException [Inherited From CompositeView]

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 [Inherited From BoxView] [Specified in View]

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

public float nextTabStop (float x, int tabOffset) [Specified in TabExpander]

Returns the next tab stop position given a reference position.

Returns the next tab stop position given a reference position. This view implements the tab coordinate system, and calls getTabbedSpan on the logical children in the process of layout to determine the desired span of the children. The logical children can delegate their tab expansion upward to the paragraph which knows how to expand tabs. LabelView is an example of a view that delegates its tab expansion needs upward to the paragraph.

This is implemented to try and locate a TabSet in the paragraph element's attribute set. If one can be found, its settings will be used, otherwise a default expansion will be provided. The base location for for tab expansion is the left inset from the paragraphs most recent allocation (which is what the layout of the children is based upon).
Returns: the trailing end of the tab expansion >= 0
Parameters:
- x - the X reference position
- tabOffset - the position within the text stream that the tab occurred at >= 0
See Also: TabSet, TabStop, LabelView,

public void paint (Graphics g, Shape a) [Overrides BoxView] [Specified in View]

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

protected void paintChild (Graphics g, Rectangle alloc, int index) [Inherited From BoxView]

Paints a child.

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

This is called by a child to indicate its preferred span has changed.

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 changes, Shape a, ViewFactory f) [Inherited From FlowView]

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

public void replace (int index, int length, View elems) [Inherited From BoxView]

Invalidates the layout and resizes the cache of requests/allocations.

Invalidates the layout and resizes the cache of
requests/allocations. The child allocations can still
be accessed for the old layout, but the new children
will have an offset and span of 0.
Parameters:
- 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)
- elems - the child views to add; this value can be nullto indicate no children are being added (useful to remove)

public void setAxis (int axis) [Inherited From BoxView]

Sets the tile axis property.

Sets the tile axis property. This is the axis along which
the child views are tiled.
Parameters:
- axis - either View.X_AXIS or View.Y_AXIS
Since: 1.3

protected void setFirstLineIndent (float fi)

Sets the indent on the first line.

protected void setInsets (short top, short left, short bottom, short right) [Inherited From CompositeView]

Sets the insets for the view.

protected void setJustification (int j)

Sets the type of justification.

protected void setLineSpacing (float ls)

Sets the line spacing.

protected void setParagraphInsets (AttributeSet attr) [Inherited From CompositeView]

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

public void setParent (View parent) [Inherited From FlowView]

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.

protected void setPropertiesFromAttributes ()

Set the cached properties from the attributes.

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

Sets the size of the view.

pack-private void setSpanOnAxis (int axis, float span) [Inherited From BoxView]

Sets the size of the view along an axis.

Sets the size of the view along an axis. This should cause
layout of the view along the given axis.
Parameters:
- axis - may be either View.X_AXIS or View.Y_AXIS
- span - the span to layout to >= 0

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

pack-private void updateChildSizes () [Inherited From BoxView]

Propagates the current allocations to the child views.

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

pack-private int updateLayoutArray (int[] oldArray, int offset, int nInserted) [Inherited From BoxView]

Resizes the given layout array to match the new number of child views.

Resizes the given layout array to match the new number of
child views. The current number of child views are used to
produce the new array. The contents of the old array are
inserted into the new array at the appropriate places so that
the old layout information is transferred to the new array.
Returns: the new layout array
Parameters:
- oldArray - the original layout array
- offset - location where new views will be inserted
- nInserted - the number of child views being inserted; therefore the number of blank spaces to leave in the new array at location offset

@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) [Inherited From BoxView] [Specified in View]

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