    All Packages  Class Hierarchy  This Package  Previous  Next  Index

# Class xv.xv_ParagraphView

    java.lang.Object
       |
       +----com.sun.java.swing.text.View
               |
               +----com.sun.java.swing.text.CompositeView
                       |
                       +----com.sun.java.swing.text.BoxView
                               |
                               +----xv.xv_ParagraphView

public class xv_ParagraphView
extends BoxView
implements TabExpander

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.

See Also:
  View

##

firstLineIndent
  Indentation for the first line, from the left inset.

##

xv_ParagraphView(Element)
  Constructs a ParagraphView for the given element.

##

adjustRow(xv_ParagraphView. Row, int, int)
  Adjusts the given row if possible to fit within the layout span.
breakView(int, float, Shape)
  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.

changedUpdate(DocumentEvent, Shape, ViewFactory)
  Gives notification from the document that attributes were changed in a location that this view is responsible for.
findOffsetToCharactersInString(char[], int)
  Finds the next character in the document with a character in `string`, starting at offset `start`.
getAlignment(int)
  Determines the desired alignment for this view along an axis.
getBreakWeight(int, float)
  Gets the break weight for a given location.
getPartialSize(int, int)
  Returns the size used by the views between `startOffset` and `endOffset`.
getPreferredSpan(int)
  Determines the preferred span for this view along an axis.
getResizeWeight(int)
  Gets the resize weight.
getTabSet()
  Gets the Tabset to be used in calculating tabs.
getViewAtPosition(int, Rectangle)
  Fetches the child view that represents the given position in the model.
insertUpdate(DocumentEvent, Shape, ViewFactory)
  Gives notification that something was inserted into the document in a location that this view is responsible for.
layout(int, int)
  Lays out the children.
loadChildren(ViewFactory)
  Loads all of the children to initialize the view.
nextTabStop(float, int)
  Returns the next tab stop position given a reference position.
paint(Graphics, Shape)
  Renders using the given rendering surface and area on that surface.
removeUpdate(DocumentEvent, Shape, ViewFactory)
  Gives notification that something was removed from the document in a location that this view is responsible for.

##

firstLineIndent

     protected int firstLineIndent

  Indentation for the first line, from the left inset.

##

xv_ParagraphView

     public xv_ParagraphView(Element elem)

  Constructs a ParagraphView for the given element.

  Parameters:
    elem - the element that this view is responsible for

##

loadChildren

     protected void loadChildren(ViewFactory f)

  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). This does create views to represent the child elements, but they are placed into a pool that is used in the process of formatting.

  Parameters:
    f - the view factory
  Overrides:
    loadChildren in class CompositeView

getViewAtPosition

     protected View getViewAtPosition(int pos,
                                      Rectangle a)

  Fetches the child view that represents the given position in the model. This is implemented to walk through the children looking for a range that contains the given position. In this view the children do not have a one to one mapping with the child elements (i.e. the children are actually rows that represent a portion of the element this view represents).

  Parameters:
    pos - the search position >= 0
    a - the allocation to the box on entry, and the allocation of the view containing the position on exit
  Returns:
    s the view representing the given position, or null if there isn't one
  Overrides:
    getViewAtPosition in class CompositeView

layout

     protected void layout(int width,
                           int height)

  Lays out the children. If the layout span has changed, the rows are rebuilt. The superclass functionality is called after checking and possibly rebuilding the rows. If the height has changed, the `preferenceChanged` method is called on the parent since the vertical preference is rigid.

  Parameters:
    width - the width to lay out against >= 0. This is the width inside of the inset area.
    height - the height to lay out against >= 0 (not used by paragraph, but used by the superclass). This is the height inside of the inset area.
  Overrides:
    layout in class BoxView

adjustRow

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

  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.

  Parameters:
    r - the row to adjust to the current layout span.
    desiredSpan - the current layout span >= 0
    x - the location r starts at.

nextTabStop

     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. 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
    tabOffset - the position within the text stream that the tab occurred at >= 0.
  Returns:
    the trailing end of the tab expansion >= 0
  See Also:
    TabSet, TabStop, LabelView

getTabSet

     protected TabSet getTabSet()

  Gets the Tabset to be used in calculating tabs.

  Returns:
    the TabSet

getPartialSize

     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. 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
    endOffset - the ending document offset >= startOffset
  Returns:
    the size >= 0

findOffsetToCharactersInString

     protected int findOffsetToCharactersInString(char string[],
                                                  int 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.

  Parameters:
    string - the string of characters
    start - where to start in the model >= 0
  Returns:
    the document offset or -1

paint

     public void paint(Graphics g,
                       Shape a)

  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
    a - the allocated region to render into
  Overrides:
    paint in class BoxView
  See Also:
    paint

getPreferredSpan

     public float getPreferredSpan(int axis)

  Determines the preferred span for this view along an axis. For the paragraph it's whatever it was formatted to along the x axis and whatever the box calculation is for the y axis.

  Parameters:
    axis - may be either View.X_AXIS or View.Y_AXIS
  Returns:
    s 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.
  Throws: IllegalArgumentException
    for an invalid axis
  Overrides:
    getPreferredSpan in class BoxView

getAlignment

     public float getAlignment(int 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.

  Parameters:
    axis - may be either View.X_AXIS or View.Y_AXIS
  Returns:
    s 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.
  Overrides:
    getAlignment in class BoxView

getResizeWeight

     public int getResizeWeight(int axis)

  Gets the resize weight. A value of 0 or less is not resizable.

  Parameters:
    axis - may be either View.X_AXIS or View.Y_AXIS
  Returns:
    the weight
  Throws: IllegalArgumentException
    for an invalid axis
  Overrides:
    getResizeWeight in class BoxView

breakView

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

  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_AXIS or View.Y_AXIS
    len - specifies where a potential break is desired along the given axis >= 0
    a - the current allocation of the view
  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.
  See Also:
    breakView

getBreakWeight

     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. If the length is less than one row, a value of BadBreakWeight is returned.

  Parameters:
    axis - may be either View.X_AXIS or View.Y_AXIS
    len - specifies where a potential break is desired >= 0
  Returns:
    a value indicating the attractiveness of breaking here
  See Also:
    getBreakWeight

insertUpdate

     public void insertUpdate(DocumentEvent changes,
                              Shape a,
                              ViewFactory f)

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

  Parameters:
    changes - 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
  Overrides:
    insertUpdate in class BoxView
  See Also:
    insertUpdate

removeUpdate

     public void removeUpdate(DocumentEvent changes,
                              Shape a,
                              ViewFactory f)

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

  Parameters:
    changes - 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
  Overrides:
    removeUpdate in class BoxView
  See Also:
    removeUpdate

changedUpdate

     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.

  Parameters:
    changes - 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
  Overrides:
    changedUpdate in class BoxView
  See Also:
    changedUpdate

    All Packages  Class Hierarchy  This Package  Previous  Next  Index