Modifier and Type	Class and Description
pack-priv class	WrappedPlainView.WrappedLine Simple view of a line that wraps if it doesn't fit within the horizontal space allocated.

Modifier and Type	Field and Description
private final boolean	drawLineOverridden
private final boolean	drawSelectedTextOverridden
private final boolean	drawUnselectedTextOverridden
pack-priv Segment	lineBuffer
pack-priv FontMetrics	metrics
pack-priv int	sel0
pack-priv int	sel1
pack-priv Color	selected
pack-priv int	tabBase
pack-priv float	tabSize
pack-priv Color	unselected
private final boolean	useFloatingPointAPI
pack-priv boolean	widthChanging
pack-priv boolean	wordWrap

Access	Constructor and Description
public	WrappedPlainView(Element the element underlying the view elem) Creates a new WrappedPlainView.
public	WrappedPlainView(Element the element underlying the view elem, boolean should lines be wrapped on word boundaries? wordWrap) Creates a new WrappedPlainView.

Method Summary

Modifier and Type	Method and Description
protected int	Returns: the break position calculateBreakPosition(int the starting document location p0, int the ending document location to use p1) This is called by the nested wrapped line views to determine the break location.
private float	callDrawSelectedText(Graphics g, float x, float y, int p0, int p1)
private float	callDrawUnselectedText(Graphics g, float x, float y, int p0, int p1)
public void	changedUpdate(DocumentEvent the change information from the associated document e, Shape the current allocation of the view a, ViewFactory the factory to use to rebuild if the view has children f) Overrides javax.swing.text.View.changedUpdate. Gives notification from the document that attributes were changed in a location that this view is responsible for.
protected void	drawLine(int the starting document location to use >= 0 p0, int the ending document location to use >= p1 p1, Graphics the graphics context g, int the starting X position >= 0 x, int the starting Y position >= 0 y) Deprecated since 9. replaced by `drawLine(int, int, Graphics2D, float, float)` Renders a line of text, suppressing whitespace at the end and expanding any tabs.
protected void	drawLine(int the starting document location to use >= 0 p0, int the ending document location to use >= p1 p1, Graphics2D the graphics context g, float the starting X position >= 0 x, float the starting Y position >= 0 y) Renders a line of text, suppressing whitespace at the end and expanding any tabs.
private void	drawLineImpl(int p0, int p1, Graphics g, float x, float y, boolean useFPAPI)
protected int	Returns: the location of the end of the range. drawSelectedText(Graphics the graphics context g, int the starting X coordinate >= 0 x, int the starting Y coordinate >= 0 y, int the beginning position in the model >= 0 p0, int the ending position in the model >= p0 p1) Deprecated since 9. replaced by `drawSelectedText(Graphics2D, float, float, int, int)` Renders the given range in the model as selected text.
protected float	Returns: the location of the end of the range. drawSelectedText(Graphics2D the graphics context g, float the starting X coordinate >= 0 x, float the starting Y coordinate >= 0 y, int the beginning position in the model >= 0 p0, int the ending position in the model >= p0 p1) Renders the given range in the model as selected text.
private float	drawSelectedTextImpl(Graphics g, float x, float y, int p0, int p1, boolean useFPAPI)
private float	drawText(Element elem, int p0, int p1, Graphics g, float x, float y)
protected int	Returns: the X location of the end of the range >= 0 drawUnselectedText(Graphics the graphics context g, int the starting X coordinate >= 0 x, int the starting Y coordinate >= 0 y, int the beginning position in the model >= 0 p0, int the ending position in the model >= p0 p1) Deprecated since 9. replaced by `drawUnselectedText(Graphics2D, float, float, int, int)` Renders the given range in the model as normal unselected text.
protected float	Returns: the X location of the end of the range >= 0 drawUnselectedText(Graphics2D the graphics context g, float the starting X coordinate >= 0 x, float the starting Y coordinate >= 0 y, int the beginning position in the model >= 0 p0, int the ending position in the model >= p0 p1) Renders the given range in the model as normal unselected text.
private float	drawUnselectedTextImpl(Graphics g, float x, float y, int p0, int p1, boolean useFPAPI)
protected final Segment	Returns: the buffer getLineBuffer() Gives access to a buffer that can be used to fetch text from the associated document.
public float	Returns: the span the view would like to be rendered into. 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. getMaximumSpan(int may be either View.X_AXIS or View.Y_AXIS axis) Overrides javax.swing.text.BoxView.getMaximumSpan. Determines the maximum span for this view along an axis.
public float	Returns: the span the view would like to be rendered into. 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. getMinimumSpan(int may be either View.X_AXIS or View.Y_AXIS axis) Overrides javax.swing.text.BoxView.getMinimumSpan. Determines the minimum span for this view along an axis.
public float	Returns: the span the view would like to be rendered into. 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. getPreferredSpan(int may be either View.X_AXIS or View.Y_AXIS axis) Overrides javax.swing.text.BoxView.getPreferredSpan. Determines the preferred span for this view along an axis.
protected int	Returns: the tab size getTabSize() Returns the tab size set for the document, defaulting to 8.
public void	insertUpdate(DocumentEvent the change information from the associated document e, Shape the current allocation of the view a, ViewFactory the factory to use to rebuild if the view has children f) Overrides javax.swing.text.View.insertUpdate. Gives notification that something was inserted into the document in a location that this view is responsible for.
protected void	loadChildren(ViewFactory the view factory f) Overrides javax.swing.text.CompositeView.loadChildren. Loads all of the children to initialize the view.
pack-priv final void	loadText(Segment segment, int p0, int p1) Load the text buffer with the given range of text.
public float	Returns: the tab stop, measured in points >= 0 nextTabStop(float the current position >= 0 x, int the position within the text stream that the tab occurred at >= 0. tabOffset) Implements javax.swing.text.TabExpander.nextTabStop. Returns the next tab stop position after a given reference position.
public void	paint(Graphics the rendering surface to use g, Shape the allocated region to render into a) Overrides javax.swing.text.BoxView.paint. Renders using the given rendering surface and area on that surface.
public void	removeUpdate(DocumentEvent the change information from the associated document e, Shape the current allocation of the view a, ViewFactory the factory to use to rebuild if the view has children f) Overrides javax.swing.text.View.removeUpdate. Gives notification that something was removed from the document in a location that this view is responsible for.
public void	setSize(float the width >= 0 width, float the height >= 0 height) Overrides javax.swing.text.BoxView.setSize. Sets the size of the view.
pack-priv void	updateChildren(DocumentEvent e, Shape a) Update the child views in response to a document event.
pack-priv final void	updateMetrics()

Field Detail

drawLineOverridden	back to summary
private final boolean drawLineOverridden

drawSelectedTextOverridden	back to summary
private final boolean drawSelectedTextOverridden

drawUnselectedTextOverridden	back to summary
private final boolean drawUnselectedTextOverridden

lineBuffer	back to summary
pack-priv Segment lineBuffer

metrics	back to summary
pack-priv FontMetrics metrics

sel0	back to summary
pack-priv int sel0

sel1	back to summary
pack-priv int sel1

selected	back to summary
pack-priv Color selected

tabBase	back to summary
pack-priv int tabBase

tabSize	back to summary
pack-priv float tabSize

unselected	back to summary
pack-priv Color unselected

useFloatingPointAPI	back to summary
private final boolean useFloatingPointAPI

widthChanging	back to summary
pack-priv boolean widthChanging

wordWrap	back to summary
pack-priv boolean wordWrap

Constructor Detail

WrappedPlainView	back to summary
public WrappedPlainView(Element elem) Creates a new WrappedPlainView. Lines will be wrapped on character boundaries. Parameters elem:Element the element underlying the view

WrappedPlainView

back to summary

public WrappedPlainView(Element elem)

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

Parameters

elem:Element: the element underlying the view

WrappedPlainView	back to summary
public WrappedPlainView(Element elem, boolean wordWrap) Creates a new WrappedPlainView. Lines can be wrapped on either character or word boundaries depending upon the setting of the wordWrap parameter. Parameters elem:Element the element underlying the view wordWrap:boolean should lines be wrapped on word boundaries?

WrappedPlainView

back to summary

public WrappedPlainView(Element elem, boolean wordWrap)

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

Parameters

elem:Element: the element underlying the view
wordWrap:boolean: should lines be wrapped on word boundaries?

Method Detail

calculateBreakPosition	back to summary
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 boundaries depending upon the break argument given at construction. Parameters p0:int the starting document location p1:int the ending document location to use Returns:int the break position

calculateBreakPosition

back to summary

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 boundaries depending upon the break argument given at construction.

Parameters

p0:int: the starting document location
p1:int: the ending document location to use

Returns:int

the break position

callDrawSelectedText	back to summary
private float callDrawSelectedText(Graphics g, float x, float y, int p0, int p1) throws BadLocationException

callDrawUnselectedText	back to summary
private float callDrawUnselectedText(Graphics g, float x, float y, int p0, int p1) throws BadLocationException

changedUpdate back to summary

changedUpdate	back to summary
public void changedUpdate(DocumentEvent e, Shape a, ViewFactory f) Overrides javax.swing.text.View.changedUpdate. Gives notification from the document that attributes were changed in a location that this view is responsible for. Parameters e:DocumentEvent the change information from the associated document a:Shape the current allocation of the view f:ViewFactory the factory to use to rebuild if the view has children See Also `View#changedUpdate`

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

Overrides javax.swing.text.View.changedUpdate.

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

Parameters

e:DocumentEvent: the change information from the associated document
a:Shape: the current allocation of the view
f:ViewFactory: the factory to use to rebuild if the view has children

See Also

View#changedUpdate

drawLine back to summary

drawLine	back to summary
protected void drawLine(int p0, int p1, Graphics g, int x, int y) Deprecated since 9. replaced by `drawLine(int, int, Graphics2D, float, float)` 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:int the starting document location to use >= 0 p1:int the ending document location to use >= p1 g:Graphics the graphics context x:int the starting X position >= 0 y:int the starting Y position >= 0 Annotations @Deprecated since:9 See Also `drawUnselectedText`, `drawSelectedText`

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

Deprecated

since 9.

replaced by drawLine(int, int, Graphics2D, float, float)

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:int: the starting document location to use >= 0
p1:int: the ending document location to use >= p1
g:Graphics: the graphics context
x:int: the starting X position >= 0
y:int: the starting Y position >= 0

Annotations

@Deprecated
since:9

drawLine back to summary

drawLine	back to summary
protected void drawLine(int p0, int p1, Graphics2D g, float x, float 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:int the starting document location to use >= 0 p1:int the ending document location to use >= p1 g:Graphics2D the graphics context x:float the starting X position >= 0 y:float the starting Y position >= 0 Since 9 See Also `drawUnselectedText`, `drawSelectedText`

protected void drawLine(int p0, int p1, Graphics2D g, float x, float y)

Parameters

p0:int: the starting document location to use >= 0
p1:int: the ending document location to use >= p1
g:Graphics2D: the graphics context
x:float: the starting X position >= 0
y:float: the starting Y position >= 0

Since

drawLineImpl	back to summary
private void drawLineImpl(int p0, int p1, Graphics g, float x, float y, boolean useFPAPI)

drawSelectedText back to summary

drawSelectedText	back to summary
protected int drawSelectedText(Graphics g, int x, int y, int p0, int p1) throws BadLocationException Deprecated since 9. replaced by `drawSelectedText(Graphics2D, float, float, int, int)` 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:Graphics the graphics context x:int the starting X coordinate >= 0 y:int the starting Y coordinate >= 0 p0:int the beginning position in the model >= 0 p1:int the ending position in the model >= p0 Returns:int the location of the end of the range. Annotations @Deprecated since:9 Exceptions BadLocationException: if the range is invalid

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

Deprecated

since 9.

replaced by drawSelectedText(Graphics2D, float, float, int, int)

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:Graphics: the graphics context
x:int: the starting X coordinate >= 0
y:int: the starting Y coordinate >= 0
p0:int: the beginning position in the model >= 0
p1:int: the ending position in the model >= p0

Returns:int

the location of the end of the range.

Annotations

@Deprecated
since:9

Exceptions

BadLocationException:: if the range is invalid

drawSelectedText	back to summary
protected float drawSelectedText(Graphics2D g, float x, float 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:Graphics2D the graphics context x:float the starting X coordinate >= 0 y:float the starting Y coordinate >= 0 p0:int the beginning position in the model >= 0 p1:int the ending position in the model >= p0 Returns:float the location of the end of the range. Exceptions BadLocationException: if the range is invalid Since 9

drawSelectedText

back to summary

protected float drawSelectedText(Graphics2D g, float x, float y, int p0, int p1) throws BadLocationException

Parameters

g:Graphics2D: the graphics context
x:float: the starting X coordinate >= 0
y:float: the starting Y coordinate >= 0
p0:int: the beginning position in the model >= 0
p1:int: the ending position in the model >= p0

Returns:float

the location of the end of the range.

Exceptions

BadLocationException:: if the range is invalid

Since

drawSelectedTextImpl	back to summary
private float drawSelectedTextImpl(Graphics g, float x, float y, int p0, int p1, boolean useFPAPI) throws BadLocationException

drawText	back to summary
private float drawText(Element elem, int p0, int p1, Graphics g, float x, float y) throws BadLocationException

drawUnselectedText back to summary

drawUnselectedText	back to summary
protected int drawUnselectedText(Graphics g, int x, int y, int p0, int p1) throws BadLocationException Deprecated since 9. replaced by `drawUnselectedText(Graphics2D, float, float, int, int)` Renders the given range in the model as normal unselected text. Parameters g:Graphics the graphics context x:int the starting X coordinate >= 0 y:int the starting Y coordinate >= 0 p0:int the beginning position in the model >= 0 p1:int the ending position in the model >= p0 Returns:int the X location of the end of the range >= 0 Annotations @Deprecated since:9 Exceptions BadLocationException: if the range is invalid

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

Deprecated

since 9.

replaced by drawUnselectedText(Graphics2D, float, float, int, int)

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

Parameters

g:Graphics: the graphics context
x:int: the starting X coordinate >= 0
y:int: the starting Y coordinate >= 0
p0:int: the beginning position in the model >= 0
p1:int: the ending position in the model >= p0

Returns:int

the X location of the end of the range >= 0

Annotations

@Deprecated
since:9

Exceptions

BadLocationException:: if the range is invalid

drawUnselectedText	back to summary
protected float drawUnselectedText(Graphics2D g, float x, float y, int p0, int p1) throws BadLocationException Renders the given range in the model as normal unselected text. Parameters g:Graphics2D the graphics context x:float the starting X coordinate >= 0 y:float the starting Y coordinate >= 0 p0:int the beginning position in the model >= 0 p1:int the ending position in the model >= p0 Returns:float the X location of the end of the range >= 0 Exceptions BadLocationException: if the range is invalid Since 9

drawUnselectedText

back to summary

protected float drawUnselectedText(Graphics2D g, float x, float y, int p0, int p1) throws BadLocationException

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

Parameters

g:Graphics2D: the graphics context
x:float: the starting X coordinate >= 0
y:float: the starting Y coordinate >= 0
p0:int: the beginning position in the model >= 0
p1:int: the ending position in the model >= p0

Returns:float

the X location of the end of the range >= 0

Exceptions

BadLocationException:: if the range is invalid

Since

drawUnselectedTextImpl	back to summary
private float drawUnselectedTextImpl(Graphics g, float x, float y, int p0, int p1, boolean useFPAPI) throws BadLocationException

getLineBuffer	back to summary
protected final Segment getLineBuffer() Gives access to a buffer that can be used to fetch text from the associated document. Returns:Segment the buffer

getLineBuffer

back to summary

protected final Segment getLineBuffer()

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

Returns:Segment: the buffer

getMaximumSpan back to summary

getMaximumSpan	back to summary
public float getMaximumSpan(int axis) Overrides javax.swing.text.BoxView.getMaximumSpan. Determines the maximum 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:int may be either View.X_AXIS or View.Y_AXIS Returns:float the span the view would like to be rendered into. 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. See Also `View#getMaximumSpan`

public float getMaximumSpan(int axis)

Overrides javax.swing.text.BoxView.getMaximumSpan.

Determines the maximum 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:int: may be either View.X_AXIS or View.Y_AXIS

Returns:float

the span the view would like to be rendered into. 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.

See Also

View#getMaximumSpan

getMinimumSpan back to summary

getMinimumSpan	back to summary
public float getMinimumSpan(int axis) Overrides javax.swing.text.BoxView.getMinimumSpan. Determines the minimum 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:int may be either View.X_AXIS or View.Y_AXIS Returns:float the span the view would like to be rendered into. 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. See Also `View#getMinimumSpan`

public float getMinimumSpan(int axis)

Overrides javax.swing.text.BoxView.getMinimumSpan.

Determines the minimum 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:int: may be either View.X_AXIS or View.Y_AXIS

Returns:float

See Also

View#getMinimumSpan

getPreferredSpan back to summary

getPreferredSpan	back to summary
public float getPreferredSpan(int axis) Overrides javax.swing.text.BoxView.getPreferredSpan. 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:int may be either View.X_AXIS or View.Y_AXIS Returns:float the span the view would like to be rendered into. 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. See Also `View#getPreferredSpan`

public float getPreferredSpan(int axis)

Overrides javax.swing.text.BoxView.getPreferredSpan.

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:int: may be either View.X_AXIS or View.Y_AXIS

Returns:float

See Also

View#getPreferredSpan

getTabSize	back to summary
protected int getTabSize() Returns the tab size set for the document, defaulting to 8. Returns:int the tab size

getTabSize

back to summary

protected int getTabSize()

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

Returns:int: the tab size

insertUpdate back to summary

insertUpdate	back to summary
public void insertUpdate(DocumentEvent e, Shape a, ViewFactory f) Overrides javax.swing.text.View.insertUpdate. 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:DocumentEvent the change information from the associated document a:Shape the current allocation of the view f:ViewFactory the factory to use to rebuild if the view has children See Also `View#insertUpdate`

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

Overrides javax.swing.text.View.insertUpdate.

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:DocumentEvent: the change information from the associated document
a:Shape: the current allocation of the view
f:ViewFactory: the factory to use to rebuild if the view has children

See Also

View#insertUpdate

loadChildren back to summary

loadChildren	back to summary
protected void loadChildren(ViewFactory f) Overrides javax.swing.text.CompositeView.loadChildren. 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:ViewFactory the view factory

protected void loadChildren(ViewFactory f)

Overrides javax.swing.text.CompositeView.loadChildren.

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:ViewFactory: the view factory

loadText	back to summary
pack-priv final void loadText(Segment segment, int p0, int p1) Load the text buffer with the given range of text. This is used by the fragments broken off of this view as well as this view itself.

nextTabStop	back to summary
public float nextTabStop(float x, int tabOffset) Implements javax.swing.text.TabExpander.nextTabStop. 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. Parameters x:float the current position >= 0 tabOffset:int the position within the text stream that the tab occurred at >= 0. Returns:float the tab stop, measured in points >= 0

nextTabStop

back to summary

public float nextTabStop(float x, int tabOffset)

Implements javax.swing.text.TabExpander.nextTabStop.

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.

Parameters

x:float: the current position >= 0
tabOffset:int: the position within the text stream that the tab occurred at >= 0.

Returns:float

the tab stop, measured in points >= 0

paint back to summary

paint	back to summary
public void paint(Graphics g, Shape a) Overrides javax.swing.text.BoxView.paint. 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:Graphics the rendering surface to use a:Shape the allocated region to render into See Also `View#paint`

public void paint(Graphics g, Shape a)

Overrides javax.swing.text.BoxView.paint.

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:Graphics: the rendering surface to use
a:Shape: the allocated region to render into

See Also

View#paint

removeUpdate back to summary

removeUpdate	back to summary
public void removeUpdate(DocumentEvent e, Shape a, ViewFactory f) Overrides javax.swing.text.View.removeUpdate. 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:DocumentEvent the change information from the associated document a:Shape the current allocation of the view f:ViewFactory the factory to use to rebuild if the view has children See Also `View#removeUpdate`

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

Overrides javax.swing.text.View.removeUpdate.

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:DocumentEvent: the change information from the associated document
a:Shape: the current allocation of the view
f:ViewFactory: the factory to use to rebuild if the view has children

See Also

View#removeUpdate

setSize	back to summary
public void setSize(float width, float height) Overrides javax.swing.text.BoxView.setSize. Sets the size of the view. This should cause layout of the view along the given axis, if it has any layout duties. Parameters width:float the width >= 0 height:float the height >= 0

setSize

back to summary

public void setSize(float width, float height)

Overrides javax.swing.text.BoxView.setSize.

Sets the size of the view. This should cause layout of the view along the given axis, if it has any layout duties.

Parameters

width:float: the width >= 0
height:float: the height >= 0

updateChildren	back to summary
pack-priv void updateChildren(DocumentEvent e, Shape a) Update the child views in response to a document event.

updateMetrics	back to summary
pack-priv final void updateMetrics()

javax.swing.text back to summary

pack-priv Class WrappedPlainView.WrappedLine

Class Inheritance

extends View

java.lang.Object
javax.swing.text.View
javax.swing.text.WrappedPlainView.WrappedLine

Simple view of a line that wraps if it doesn't fit within the horizontal space allocated. This class tries to be lightweight by carrying little state of its own and sharing the state of the outer class with its siblings.

Field Summary

Modifier and Type	Field and Description
pack-priv SoftReference<int[]>	lineCache
pack-priv int	lineCount

Inherited from javax.swing.text.View:: BadBreakWeight ExcellentBreakWeight firstUpdateIndex ForcedBreakWeight GoodBreakWeight lastUpdateIndex sharedBiasReturn X_AXIS Y_AXIS

Constructor Summary

Access	Constructor and Description
pack-priv	WrappedLine(Element elem)

Method Summary

Modifier and Type	Method and Description
pack-priv final int[]	Returns: the cache created, ot null if text breaks into one line breakLines(int position to start breaking from startPos) Creates line cache if text breaks into more than one physical line.
private int	findLine(int offset) Binary search in the cache for line containing specified offset (which is relative to the beginning of the view).
private int	findLine(int[] array, int offset, int min, int max)
pack-priv final int[]	getLineEnds() Returns line cache.
public float	Returns: the span the view would like to be rendered into. 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. getPreferredSpan(int may be either X_AXIS or Y_AXIS axis) Implements abstract javax.swing.text.View.getPreferredSpan. Determines the preferred span for this view along an axis.
public void	insertUpdate(DocumentEvent e, Shape a, ViewFactory f) Overrides javax.swing.text.View.insertUpdate. Gives notification that something was inserted into the document in a location that this view is responsible for.
public Shape	Returns: the bounding box of the given position is returned modelToView(int the position to convert pos, Shape the allocated region to render into a, Position.Bias b) Implements abstract javax.swing.text.View.modelToView. Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it.
public void	paint(Graphics the rendering surface to use g, Shape the allocated region to render into a) Implements abstract javax.swing.text.View.paint. Renders using the given rendering surface and area on that surface.
public void	removeUpdate(DocumentEvent e, Shape a, ViewFactory f) Overrides javax.swing.text.View.removeUpdate. Gives notification that something was removed from the document in a location that this view is responsible for.
private void	update(DocumentEvent ev, Shape a)
public int	Returns: the location within the model that best represents the given point in the view viewToModel(float the X coordinate fx, float the Y coordinate fy, Shape the allocated region to render into a, Position.Bias[] bias) Implements abstract javax.swing.text.View.viewToModel. Provides a mapping from the view coordinate space to the logical coordinate space of the model.

Field Detail

lineCache	back to summary
pack-priv SoftReference<int[]> lineCache

lineCount	back to summary
pack-priv int lineCount

Constructor Detail

WrappedLine	back to summary
pack-priv WrappedLine(Element elem)

Method Detail

breakLines

back to summary

pack-priv final int[] breakLines(int startPos)

Creates line cache if text breaks into more than one physical line.

Parameters

startPos:int: position to start breaking from

Returns:int[]

the cache created, ot null if text breaks into one line

findLine	back to summary
private int findLine(int offset) Binary search in the cache for line containing specified offset (which is relative to the beginning of the view). This method assumes that cache exists.

findLine	back to summary
private int findLine(int[] array, int offset, int min, int max)

getLineEnds	back to summary
pack-priv final int[] getLineEnds() Returns line cache. If the cache was GC'ed, recreates it. If there's no cache, returns null

getPreferredSpan back to summary

public float getPreferredSpan(int axis)

Implements abstract javax.swing.text.View.getPreferredSpan.

Determines the preferred span for this view along an axis.

Parameters

axis:int: may be either X_AXIS or Y_AXIS

Returns:float

See Also

View#getPreferredSpan

insertUpdate back to summary

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

Overrides javax.swing.text.View.insertUpdate.

Doc from javax.swing.text.View.insertUpdate.

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:

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.
forwardUpdate is called to forward the DocumentEvent to the appropriate child views.
updateLayout is called to give the view a chance to either repair its layout, to reschedule layout, or do nothing.

modelToView back to summary

public Shape modelToView(int pos, Shape a, Position.Bias b) throws BadLocationException

Implements abstract javax.swing.text.View.modelToView.

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

Parameters

pos:int: the position to convert
a:Shape: the allocated region to render into

Returns:Shape

the bounding box of the given position is returned

Exceptions

BadLocationException:: if the given position does not represent a valid location in the associated document

See Also

View#modelToView

paint back to summary

public void paint(Graphics g, Shape a)

Implements abstract javax.swing.text.View.paint.

Renders using the given rendering surface and area on that surface. The view may need to do layout and create child views to enable itself to render into the given allocation.

Parameters

g:Graphics: the rendering surface to use
a:Shape: the allocated region to render into

See Also

View#paint

removeUpdate back to summary

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

Overrides javax.swing.text.View.removeUpdate.

Doc from javax.swing.text.View.removeUpdate.

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:

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.
forwardUpdate is called to forward the DocumentEvent to the appropriate child views.
updateLayout is called to give the view a chance to either repair its layout, to reschedule layout, or do nothing.

update	back to summary
private void update(DocumentEvent ev, Shape a)

viewToModel back to summary

public int viewToModel(float fx, float fy, Shape a, Position.Bias[] bias)

Implements abstract javax.swing.text.View.viewToModel.

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

Parameters

fx:float: the X coordinate
fy:float: the Y coordinate
a:Shape: the allocated region to render into

Returns:int

the location within the model that best represents the given point in the view

See Also

View#viewToModel

public Class WrappedPlainView

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class WrappedPlainView.WrappedLine

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail