| java.lang.Object
 javax.swing.text.View
javax.swing.text.CompositeView
javax.swing.text.BoxView
javax.swing.text.FlowView
javax.swing.text.ParagraphView
All known Subclasses: javax.swing.text.html.ParagraphView,
| ParagraphView | | public class ParagraphView extends FlowView implements TabExpander(Code) | | View of a simple line-wrapping paragraph that supports
multiple fonts, colors, components, icons, etc. It is
basically a vertical box with a margin around it. The
contents of the box are a bunch of rows which are special
horizontal boxes. This view creates a collection of
views that represent the child elements of the paragraph
element. Each of these views are placed into a row
directly if they will fit, otherwise the breakView
method is called to try and carve the view into pieces
that fit.
author:
Timothy Prinzing
author:
Scott Violet
author:
Igor Kushnirskiy
version:
1.103 05/05/07
See Also: View |
| Inner Class :class Row extends BoxView | |
| Constructor Summary | |
| public | ParagraphView(Element elem)
Constructs a ParagraphView for the given element. |
| Method Summary | |
| protected void | adjustRow(Row r, int desiredSpan, int x)
Adjusts the given row if possible to fit within the
layout span. | | public View | breakView(int axis, float len, Shape a)
Breaks this view on the given axis at the given length. | | public void | changedUpdate(DocumentEvent changes, Shape a, ViewFactory f)
Gives notification from the document that attributes were changed
in a location that this view is responsible for. | | protected View | createRow()
Create a View that should be used to hold a
a row's worth of children in a flow. | | protected int | findOffsetToCharactersInString(char[] string, int start)
Finds the next character in the document with a character in
string, starting at offset start. | | protected boolean | flipEastAndWestAtEnds(int position, Position.Bias bias)
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. | | public float | getAlignment(int axis)
Determines the desired alignment for this view along an
axis. | | public int | getBreakWeight(int axis, float len)
Gets the break weight for a given location.
ParagraphView instances are breakable
along the Y_AXIS only, and only if
len is after the first row. | | protected int | getClosestPositionTo(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet, int rowIndex, int x)
Returns the closest model position to x. | | public int | getFlowSpan(int index)
Fetches the constraining span to flow against for
the given child index. | | public int | getFlowStart(int index)
Fetches the location along the flow axis that the
flow span will start at. | | protected View | getLayoutView(int 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. | | protected int | getLayoutViewCount()
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. | | 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. | | protected float | getPartialSize(int startOffset, int 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. | | protected float | getTabBase()
Returns where the tabs are calculated from. | | protected TabSet | getTabSet()
Gets the Tabset to be used in calculating tabs. | | public float | nextTabStop(float x, int tabOffset)
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. | | public void | paint(Graphics g, Shape a)
Renders using the given rendering surface and area on that
surface. | | protected void | setFirstLineIndent(float fi)
Sets the indent on the first line. | | protected void | setJustification(int j)
Sets the type of justification. | | protected void | setLineSpacing(float ls)
Sets the line spacing. | | protected void | setPropertiesFromAttributes()
Set the cached properties from the attributes. |
| firstLineIndent | | protected int firstLineIndent(Code) | | Indentation for the first line, from the left inset.
|
| i18nStrategy | | static Class i18nStrategy(Code) | | Used to create an i18n-based layout strategy
|
| tabChars | | static char[] tabChars(Code) | | Used for searching for a tab.
|
| tabDecimalChars | | static char[] tabDecimalChars(Code) | | Used for searching for a tab or decimal character.
|
| ParagraphView | | public ParagraphView(Element elem)(Code) | | Constructs a ParagraphView for the given element.
Parameters:
elem - the element that this view is responsible for |
| adjustRow | | protected void adjustRow(Row r, int desiredSpan, int x)(Code) | | Adjusts the given row if possible to fit within the
layout span. By default this will try to find the
highest break weight possible nearest the end of
the row. If a forced break is encountered, the
break will be positioned there.
This is meant for internal usage, and should not be used directly.
Parameters:
r - the row to adjust to the current layoutspan
Parameters:
desiredSpan - the current layout span >= 0
Parameters:
x - the location r starts at |
| breakView | | public View breakView(int axis, float len, Shape a)(Code) | | Breaks this view on the given axis at the given length.
ParagraphView instances are breakable
along the Y_AXIS only, and only if
len is after the first line.
Parameters:
axis - may be either View.X_AXISor View.Y_AXIS
Parameters:
len - specifies where a potential break is desiredalong the given axis >= 0
Parameters:
a - the current allocation of the view the fragment of the view that represents thegiven span, if the view can be broken; if the viewdoesn't support breaking behavior, the view itself isreturned
See Also: View.breakView |
| changedUpdate | | public void changedUpdate(DocumentEvent changes, Shape a, ViewFactory f)(Code) | | Gives notification from the document that attributes were changed
in a location that this view is responsible for.
Parameters:
changes - the change information from the associated document
Parameters:
a - the current allocation of the view
Parameters:
f - the factory to use to rebuild if the view has children
See Also: View.changedUpdate |
| createRow | | protected View createRow()(Code) | | Create a View that should be used to hold a
a row's worth of children in a flow.
the new View
since:
1.3 |
| findOffsetToCharactersInString | | protected int findOffsetToCharactersInString(char[] string, int start)(Code) | | 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.
Parameters:
string - the string of characters
Parameters:
start - where to start in the model >= 0 the document offset, or -1 if no characters found |
| flipEastAndWestAtEnds | | protected boolean flipEastAndWestAtEnds(int position, Position.Bias bias)(Code) | | 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.
Parameters:
position - position into the model
Parameters:
bias - either Position.Bias.Forward orPosition.Bias.Backward true if the text is layed out right to left atposition, otherwise false. |
| getAlignment | | public float getAlignment(int axis)(Code) | | 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.
Parameters:
axis - may be either View.X_AXIS orView.Y_AXIS the desired alignment. This should be a valuebetween 0.0 and 1.0 inclusive, where 0 indicates alignment at theorigin and 1.0 indicates alignment to the full spanaway from the origin. An alignment of 0.5 would be thecenter of the view. |
| getBreakWeight | | public int getBreakWeight(int axis, float len)(Code) | | Gets the break weight for a given location.
ParagraphView instances are breakable
along the Y_AXIS only, and only if
len is after the first row. If the length
is less than one row, a value of BadBreakWeight
is returned.
Parameters:
axis - may be either View.X_AXISor View.Y_AXIS
Parameters:
len - specifies where a potential break is desired >= 0 a value indicating the attractiveness of breaking here;either GoodBreakWeight or BadBreakWeight
See Also: View.getBreakWeight |
| getClosestPositionTo | | protected int getClosestPositionTo(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet, int rowIndex, int x) throws BadLocationException(Code) | | Returns the closest model position to x.
rowIndex gives the index of the view that corresponds
that should be looked in.
Parameters:
pos - position into the model
Parameters:
a - the allocated region to render into
Parameters:
direction - one of the following values:SwingConstants.NORTHSwingConstants.SOUTH
Parameters:
biasRet - an array containing the bias that were checkedin this method
Parameters:
rowIndex - the index of the view
Parameters:
x - the x coordinate of interest the closest model position to x |
| getFlowSpan | | public int getFlowSpan(int index)(Code) | | Fetches the constraining span to flow against for
the given child index.
Parameters:
index - the index of the view being queried the constraining span for the given view atindex
since:
1.3 |
| getFlowStart | | public int getFlowStart(int index)(Code) | | Fetches the location along the flow axis that the
flow span will start at.
Parameters:
index - the index of the view being queried the location for the given view atindex
since:
1.3 |
| getLayoutView | | protected View getLayoutView(int index)(Code) | | 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.
Parameters:
index - the index of the desired view the view at index |
| getLayoutViewCount | | protected int getLayoutViewCount()(Code) | | 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.
the number of views that this ParagraphViewis responsible for |
| getNextNorthSouthVisualPositionFrom | | protected int getNextNorthSouthVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet) throws BadLocationException(Code) | | Returns the next visual position for the cursor, in
either the east or west direction.
Overridden from CompositeView.
Parameters:
pos - position into the model
Parameters:
b - either Position.Bias.Forward orPosition.Bias.Backward
Parameters:
a - the allocated region to render into
Parameters:
direction - either SwingConstants.NORTHor SwingConstants.SOUTH
Parameters:
biasRet - an array containing the bias that were checkedin this method the location in the model that represents thenext location visual position |
| getPartialSize | | protected float getPartialSize(int startOffset, int endOffset)(Code) | | 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.
Parameters:
startOffset - the starting document offset >= 0
Parameters:
endOffset - the ending document offset >= startOffset the size >= 0 |
| getTabBase | | protected float getTabBase()(Code) | | Returns where the tabs are calculated from.
where tabs are calculated from |
| getTabSet | | protected TabSet getTabSet()(Code) | | Gets the Tabset to be used in calculating tabs.
the TabSet |
| nextTabStop | | public float nextTabStop(float x, int tabOffset)(Code) | | 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).
Parameters:
x - the X reference position
Parameters:
tabOffset - the position within the text streamthat the tab occurred at >= 0 the trailing end of the tab expansion >= 0
See Also: TabSet
See Also: TabStop
See Also: LabelView |
| paint | | public void paint(Graphics g, Shape a)(Code) | | Renders using the given rendering surface and area on that
surface. This is implemented to delgate to the superclass
after stashing the base coordinate for tab calculations.
Parameters:
g - the rendering surface to use
Parameters:
a - the allocated region to render into
See Also: View.paint |
| setFirstLineIndent | | protected void setFirstLineIndent(float fi)(Code) | | Sets the indent on the first line.
Parameters:
fi - the value in points |
| setJustification | | protected void setJustification(int j)(Code) | | Sets the type of justification.
Parameters:
j - one of the following values:StyleConstants.ALIGN_LEFTStyleConstants.ALIGN_CENTERStyleConstants.ALIGN_RIGHT
|
| setLineSpacing | | protected void setLineSpacing(float ls)(Code) | | Sets the line spacing.
Parameters:
ls - the value is a factor of the line hight |
| setPropertiesFromAttributes | | protected void setPropertiesFromAttributes()(Code) | | Set the cached properties from the attributes.
|
| Methods inherited from javax.swing.text.BoxView | protected void baselineLayout(int targetSpan, int axis, int[] offsets, int[] spans)(Code)(Java Doc)
protected SizeRequirements baselineRequirements(int axis, SizeRequirements r)(Code)(Java Doc)
protected SizeRequirements calculateMajorAxisRequirements(int axis, SizeRequirements r)(Code)(Java Doc)
protected SizeRequirements calculateMinorAxisRequirements(int axis, SizeRequirements r)(Code)(Java Doc)
void checkRequests(int axis)(Code)(Java Doc)
protected void childAllocation(int index, Rectangle alloc)(Code)(Java Doc)
protected boolean flipEastAndWestAtEnds(int position, Position.Bias bias)(Code)(Java Doc)
protected void forwardUpdate(DocumentEvent.ElementChange ec, DocumentEvent e, Shape a, ViewFactory f)(Code)(Java Doc)
public float getAlignment(int axis)(Code)(Java Doc)
public int getAxis()(Code)(Java Doc)
public Shape getChildAllocation(int index, Shape a)(Code)(Java Doc)
public int getHeight()(Code)(Java Doc)
public float getMaximumSpan(int axis)(Code)(Java Doc)
public float getMinimumSpan(int axis)(Code)(Java Doc)
protected int getOffset(int axis, int childIndex)(Code)(Java Doc)
public float getPreferredSpan(int axis)(Code)(Java Doc)
public int getResizeWeight(int axis)(Code)(Java Doc)
protected int getSpan(int axis, int childIndex)(Code)(Java Doc)
float getSpanOnAxis(int axis)(Code)(Java Doc)
protected View getViewAtPoint(int x, int y, Rectangle alloc)(Code)(Java Doc)
public int getWidth()(Code)(Java Doc)
protected boolean isAfter(int x, int y, Rectangle innerAlloc)(Code)(Java Doc)
protected boolean isAllocationValid()(Code)(Java Doc)
protected boolean isBefore(int x, int y, Rectangle innerAlloc)(Code)(Java Doc)
protected boolean isLayoutValid(int axis)(Code)(Java Doc)
protected void layout(int width, int height)(Code)(Java Doc)
public void layoutChanged(int axis)(Code)(Java Doc)
protected void layoutMajorAxis(int targetSpan, int axis, int[] offsets, int[] spans)(Code)(Java Doc)
protected void layoutMinorAxis(int targetSpan, int axis, int[] offsets, int[] spans)(Code)(Java Doc)
public Shape modelToView(int pos, Shape a, Position.Bias b) throws BadLocationException(Code)(Java Doc)
public void paint(Graphics g, Shape allocation)(Code)(Java Doc)
protected void paintChild(Graphics g, Rectangle alloc, int index)(Code)(Java Doc)
public void preferenceChanged(View child, boolean width, boolean height)(Code)(Java Doc)
public void replace(int index, int length, View[] elems)(Code)(Java Doc)
public void setAxis(int axis)(Code)(Java Doc)
public void setSize(float width, float height)(Code)(Java Doc)
void setSpanOnAxis(int axis, float span)(Code)(Java Doc)
void updateChildSizes()(Code)(Java Doc)
int[] updateLayoutArray(int[] oldArray, int offset, int nInserted)(Code)(Java Doc)
public int viewToModel(float x, float y, Shape a, Position.Bias[] bias)(Code)(Java Doc)
|
| Methods inherited from javax.swing.text.CompositeView | abstract protected void childAllocation(int index, Rectangle a)(Code)(Java Doc)
protected boolean flipEastAndWestAtEnds(int position, Position.Bias bias)(Code)(Java Doc)
protected short getBottomInset()(Code)(Java Doc)
public Shape getChildAllocation(int index, Shape a)(Code)(Java Doc)
protected Rectangle getInsideAllocation(Shape a)(Code)(Java Doc)
protected short getLeftInset()(Code)(Java Doc)
protected int getNextEastWestVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet) throws BadLocationException(Code)(Java Doc)
protected int getNextNorthSouthVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet) throws BadLocationException(Code)(Java Doc)
public int getNextVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet) throws BadLocationException(Code)(Java Doc)
protected short getRightInset()(Code)(Java Doc)
protected short getTopInset()(Code)(Java Doc)
public View getView(int n)(Code)(Java Doc)
abstract protected View getViewAtPoint(int x, int y, Rectangle alloc)(Code)(Java Doc)
protected View getViewAtPosition(int pos, Rectangle a)(Code)(Java Doc)
public int getViewCount()(Code)(Java Doc)
public int getViewIndex(int pos, Position.Bias b)(Code)(Java Doc)
protected int getViewIndexAtPosition(int pos)(Code)(Java Doc)
abstract protected boolean isAfter(int x, int y, Rectangle alloc)(Code)(Java Doc)
abstract protected boolean isBefore(int x, int y, Rectangle alloc)(Code)(Java Doc)
protected void loadChildren(ViewFactory f)(Code)(Java Doc)
public Shape modelToView(int pos, Shape a, Position.Bias b) throws BadLocationException(Code)(Java Doc)
public Shape modelToView(int p0, Position.Bias b0, int p1, Position.Bias b1, Shape a) throws BadLocationException(Code)(Java Doc)
public void replace(int offset, int length, View[] views)(Code)(Java Doc)
protected void setInsets(short top, short left, short bottom, short right)(Code)(Java Doc)
protected void setParagraphInsets(AttributeSet attr)(Code)(Java Doc)
public void setParent(View parent)(Code)(Java Doc)
public int viewToModel(float x, float y, Shape a, Position.Bias[] bias)(Code)(Java Doc)
|
| Methods inherited from javax.swing.text.View | public void append(View v)(Code)(Java Doc)
public View breakView(int axis, int offset, float pos, float len)(Code)(Java Doc)
public void changedUpdate(DocumentEvent e, Shape a, ViewFactory f)(Code)(Java Doc)
public View createFragment(int p0, int p1)(Code)(Java Doc)
protected void forwardUpdate(DocumentEvent.ElementChange ec, DocumentEvent e, Shape a, ViewFactory f)(Code)(Java Doc)
protected void forwardUpdateToView(View v, DocumentEvent e, Shape a, ViewFactory f)(Code)(Java Doc)
public float getAlignment(int axis)(Code)(Java Doc)
public AttributeSet getAttributes()(Code)(Java Doc)
public int getBreakWeight(int axis, float pos, float len)(Code)(Java Doc)
public Shape getChildAllocation(int index, Shape a)(Code)(Java Doc)
public Container getContainer()(Code)(Java Doc)
public Document getDocument()(Code)(Java Doc)
public Element getElement()(Code)(Java Doc)
public int getEndOffset()(Code)(Java Doc)
public Graphics getGraphics()(Code)(Java Doc)
public float getMaximumSpan(int axis)(Code)(Java Doc)
public float getMinimumSpan(int axis)(Code)(Java Doc)
public int getNextVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet) throws BadLocationException(Code)(Java Doc)
public View getParent()(Code)(Java Doc)
abstract public float getPreferredSpan(int axis)(Code)(Java Doc)
public int getResizeWeight(int axis)(Code)(Java Doc)
public int getStartOffset()(Code)(Java Doc)
public String getToolTipText(float x, float y, Shape allocation)(Code)(Java Doc)
public View getView(int n)(Code)(Java Doc)
public int getViewCount()(Code)(Java Doc)
public ViewFactory getViewFactory()(Code)(Java Doc)
public int getViewIndex(int pos, Position.Bias b)(Code)(Java Doc)
public int getViewIndex(float x, float y, Shape allocation)(Code)(Java Doc)
public void insert(int offs, View v)(Code)(Java Doc)
public void insertUpdate(DocumentEvent e, Shape a, ViewFactory f)(Code)(Java Doc)
public boolean isVisible()(Code)(Java Doc)
abstract public Shape modelToView(int pos, Shape a, Position.Bias b) throws BadLocationException(Code)(Java Doc)
public Shape modelToView(int p0, Position.Bias b0, int p1, Position.Bias b1, Shape a) throws BadLocationException(Code)(Java Doc)
public Shape modelToView(int pos, Shape a) throws BadLocationException(Code)(Java Doc)
abstract public void paint(Graphics g, Shape allocation)(Code)(Java Doc)
public void preferenceChanged(View child, boolean width, boolean height)(Code)(Java Doc)
public void remove(int i)(Code)(Java Doc)
public void removeAll()(Code)(Java Doc)
public void removeUpdate(DocumentEvent e, Shape a, ViewFactory f)(Code)(Java Doc)
public void replace(int offset, int length, View[] views)(Code)(Java Doc)
public void setParent(View parent)(Code)(Java Doc)
public void setSize(float width, float height)(Code)(Java Doc)
protected boolean updateChildren(DocumentEvent.ElementChange ec, DocumentEvent e, ViewFactory f)(Code)(Java Doc)
protected void updateLayout(DocumentEvent.ElementChange ec, DocumentEvent e, Shape a)(Code)(Java Doc)
abstract public int viewToModel(float x, float y, Shape a, Position.Bias[] biasReturn)(Code)(Java Doc)
public int viewToModel(float x, float y, Shape a)(Code)(Java Doc)
|
|
|