Overview | Package | Class | Tree | Deprecated | Index | Help			Java Platform 1.1.7
PREV CLASS | NEXT CLASS	FRAMES | NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

Class com.sun.java.swing.text.WrappedPlainView

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

public class WrappedPlainView

extends BoxView

implements TabExpander

View of plain text (text with only one font and color) that does line-wrapping. This view expects that its associated element has child elements that represent the lines it should be wrapping. It is implemented as a vertical box that contains logical line views. The logical line views are nested classes that render the logical line as multiple physical line if the logical line is too wide to fit within the allocation. The line views draw upon the outer class for its state to reduce their memory requirements.

The line views do all of their rendering through the drawLine method which in turn does all of its rendering through the drawSelectedText and drawUnselectedText methods. This enables subclasses to easily specialize the rendering without concern for the layout aspects.

See Also:

View

Fields inherited from class com.sun.java.swing.text.View

BadBreakWeight, ExcellentBreakWeight, ForcedBreakWeight, GoodBreakWeight, X_AXIS, Y_AXIS

Constructor Summary

WrappedPlainView(Element elem)
Creates a new WrappedPlainView.

WrappedPlainView(Element elem, boolean wordWrap)
Creates a new WrappedPlainView.

Method Summary

int	calculateBreakPosition(int p0, int p1) This is called by the nested wrapped line views to determine the break location.
void	changedUpdate(DocumentEvent e, java.awt.Shape a, ViewFactory f) Gives notification from the document that attributes were changed in a location that this view is responsible for.
void	drawLine(int p0, int p1, java.awt.Graphics g, int x, int y) Renders a line of text, suppressing whitespace at the end and expanding any tabs.
int	drawSelectedText(java.awt.Graphics g, int x, int y, int p0, int p1) Renders the given range in the model as selected text.
int	drawUnselectedText(java.awt.Graphics g, int x, int y, int p0, int p1) Renders the given range in the model as normal unselected text.
Segment	getLineBuffer() Gives access to a buffer that can be used to fetch text from the associated document.
float	getPreferredSpan(int axis) Determines the preferred span for this view along an axis.
int	getTabSize() Returns the tab size set for the document, defaulting to 8.
void	insertUpdate(DocumentEvent e, java.awt.Shape a, ViewFactory f) Gives notification that something was inserted into the document in a location that this view is responsible for.
void	loadChildren(ViewFactory f) Loads all of the children to initialize the view.
float	nextTabStop(float x, int tabOffset) Returns the next tab stop position after a given reference position.
void	paint(java.awt.Graphics g, java.awt.Shape a) Renders using the given rendering surface and area on that surface.
void	removeUpdate(DocumentEvent e, java.awt.Shape a, ViewFactory f) Gives notification that something was removed from the document in a location that this view is responsible for.
void	setSize(float width, float height) Sets the size of the view.

Methods inherited from class com.sun.java.swing.text.BoxView

changedUpdate, childAllocation, getAlignment, getHeight, getPreferredSpan, getResizeWeight, getViewAtPoint, getWidth, insertUpdate, isAfter, isAllocationValid, isBefore, layout, modelToView, paint, paintChild, preferenceChanged, removeUpdate, replace, setSize, viewToModel

Methods inherited from class com.sun.java.swing.text.CompositeView

append, childAllocation, getBottomInset, getChildAllocation, getInsideAllocation, getLeftInset, getRightInset, getTopInset, getViewAtPoint, getViewAtPosition, getView, getViewCount, insert, isAfter, isBefore, loadChildren, modelToView, removeAll, replace, setInsets, setParagraphInsets, setParent, viewToModel

Methods inherited from class com.sun.java.swing.text.View

breakView, changedUpdate, createFragment, getAlignment, getBreakWeight, getChildAllocation, getContainer, getDocument, getElement, getEndOffset, getParent, getPreferredSpan, getResizeWeight, getStartOffset, getViewCount, getViewFactory, getView, insertUpdate, modelToView, paint, preferenceChanged, removeUpdate, setParent, setSize, viewToModel

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notifyAll, notify, toString, wait, wait, wait

Constructor Detail

WrappedPlainView

public WrappedPlainView(Element elem)

Creates a new WrappedPlainView. Lines will be wrapped on character boundries.

Parameters:

elem - the element underlying the view

WrappedPlainView

public WrappedPlainView(Element elem,
                        boolean wordWrap)

Creates a new WrappedPlainView. Lines can be wrapped on either character or word boundries depending upon the setting of the wordWrap parameter.

Parameters:

elem - the element underlying the view

wordWrap - should lines be wrapped on word boundries?

Method Detail

getTabSize

protected int getTabSize()

Returns the tab size set for the document, defaulting to 8.

Returns:

the tab size

drawLine

protected void drawLine(int p0,
                        int p1,
                        java.awt.Graphics g,
                        int x,
                        int y)

Renders a line of text, suppressing whitespace at the end and expanding any tabs. This is implemented to make calls to the methods drawUnselectedText and drawSelectedText so that the way selected and unselected text are rendered can be customized.

Parameters:

p0 - the starting document location to use >= 0

p1 - the ending document location to use >= p1

g - the graphics context

x - the starting X position >= 0

y - the starting Y position >= 0

See Also:

drawUnselectedText, drawSelectedText

drawUnselectedText

protected int drawUnselectedText(java.awt.Graphics g,
                                 int x,
                                 int y,
                                 int p0,
                                 int p1)
                         throws BadLocationException

Renders the given range in the model as normal unselected text.

Parameters:

g - the graphics context

x - the starting X coordinate >= 0

y - the starting Y coordinate >= 0

p0 - the beginning position in the model >= 0

p1 - the ending position in the model >= p0

Throws:

BadLocationException - if the range is invalid

drawSelectedText

protected int drawSelectedText(java.awt.Graphics g,
                               int x,
                               int y,
                               int p0,
                               int p1)
                       throws BadLocationException

Renders the given range in the model as selected text. This is implemented to render the text in the color specified in the hosting component. It assumes the highlighter will render the selected background.

Parameters:

g - the graphics context

x - the starting X coordinate >= 0

y - the starting Y coordinate >= 0

p0 - the beginning position in the model >= 0

p1 - the ending position in the model >= p0

Throws:

BadLocationException - if the range is invalid

getLineBuffer

protected final Segment getLineBuffer()

Gives access to a buffer that can be used to fetch text from the associated document.

calculateBreakPosition

protected int calculateBreakPosition(int p0,
                                     int p1)

This is called by the nested wrapped line views to determine the break location. This can be reimplemented to alter the breaking behavior. It will either break at word or character boundries depending upon the break argument given at construction.

loadChildren

protected void loadChildren(ViewFactory f)

Loads all of the children to initialize the view. This is called by the setParent 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

Overrides:

loadChildren in class CompositeView

nextTabStop

public float nextTabStop(float x,
                         int tabOffset)

Returns the next tab stop position after a given reference position. This implementation does not support things like centering so it ignores the tabOffset argument.

Specified by:

nextTabStop in interface TabExpander

Parameters:

x - the current position >= 0

tabOffset - the position within the text stream that the tab occurred at >= 0.

Returns:

the tab stop, measured in points >= 0

paint

public void paint(java.awt.Graphics g,
                  java.awt.Shape a)

Renders using the given rendering surface and area on that surface. This is implemented to stash the selection positions, selection colors, and font metrics for the nested lines to use.

Parameters:

g - the rendering surface to use

a - the allocated region to render into

Overrides:

paint in class BoxView

See Also:

paint

setSize

public void setSize(float width,
                    float height)

Sets the size of the view. If the size has changed, layout is redone. The size is the full size of the view including the inset areas.

Parameters:

width - the width >= 0

height - the height >= 0

Overrides:

setSize in class BoxView

getPreferredSpan

public float getPreferredSpan(int axis)

Determines the preferred span for this view along an axis. This is implemented to provide the superclass behavior after first making sure that the current font metrics are cached (for the nested lines which use the metrics to determine the height of the potentially wrapped lines).

Parameters:

axis - may be either View.X_AXIS or View.Y_AXIS

Overrides:

getPreferredSpan in class BoxView

See Also:

getPreferredSpan

insertUpdate

public void insertUpdate(DocumentEvent e,
                         java.awt.Shape a,
                         ViewFactory f)

Gives notification that something was inserted into the document in a location that this view is responsible for. This is implemented to simply update the children.

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

Overrides:

insertUpdate in class BoxView

See Also:

insertUpdate

removeUpdate

public void removeUpdate(DocumentEvent e,
                         java.awt.Shape a,
                         ViewFactory f)

Gives notification that something was removed from the document in a location that this view is responsible for. This is implemented to simply update the children.

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

Overrides:

removeUpdate in class BoxView

See Also:

removeUpdate

changedUpdate

public void changedUpdate(DocumentEvent e,
                          java.awt.Shape a,
                          ViewFactory f)

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

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

Overrides:

changedUpdate in class BoxView

See Also:

changedUpdate