Class WrappedSyntaxView

java.lang.Object

javax.swing.text.View

javax.swing.text.CompositeView

javax.swing.text.BoxView

org.fife.ui.rsyntaxtextarea.WrappedSyntaxView

All Implemented Interfaces:

SwingConstants, TabExpander

public class WrappedSyntaxView
extends BoxView
implements TabExpander

The view used by RSyntaxTextArea when word wrap is enabled.

Version:

0.2

Author:

Robert Futrell

Field Summary

Fields inherited from class View

BadBreakWeight, ExcellentBreakWeight, ForcedBreakWeight, GoodBreakWeight, X_AXIS, Y_AXIS

Fields inherited from interface SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Constructor Summary

Constructors

Constructor	Description
WrappedSyntaxView(Element elem)	Creates a new WrappedSyntaxView.

Method Summary

Modifier and Type	Method	Description
protected int	calculateBreakPosition(int p0, Token tokenList, float x0)	This is called by the nested wrapped line views to determine the break location.
void	changedUpdate(DocumentEvent e, Shape a, ViewFactory f)	Gives notification from the document that attributes were changed in a location that this view is responsible for.
protected void	drawView(org.fife.ui.rsyntaxtextarea.TokenPainter painter, Graphics2D g, Rectangle r, View view, int fontHeight, int y, int line)	Draws a single view (i.e., a line of text for a wrapped view), wrapping the text onto multiple lines if necessary.
protected void	drawViewWithSelection(org.fife.ui.rsyntaxtextarea.TokenPainter painter, Graphics2D g, Rectangle r, View view, int fontHeight, int y, int selStart, int selEnd)	Draws a single view (i.e., a line of text for a wrapped view), wrapping the text onto multiple lines if necessary.
Shape	getChildAllocation(int index, Shape a)	Fetches the allocation for the given child view.
Shape	getChildAllocationImpl(int line, Shape a)	Fetches the allocation for the given child view to render into.
float	getMaximumSpan(int axis)	Determines the maximum span for this view along an axis.
float	getMinimumSpan(int axis)	Determines the minimum span for this view along an axis.
float	getPreferredSpan(int axis)	Determines the preferred span for this view along an axis.
protected int	getTabSize()	Returns the tab size set for the document, defaulting to 5.
protected View	getViewAtPoint(int x, int y, Rectangle alloc)	Overridden to allow for folded regions.
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.
protected void	loadChildren(ViewFactory f)	Loads all of the children to initialize the view.
Shape	modelToView(int pos, Shape a, Position.Bias b)
Shape	modelToView(int p0, Position.Bias b0, int p1, Position.Bias b1, Shape a)	Provides a mapping, for a given region, from the document model coordinate space to the view coordinate space.
float	nextTabStop(float x, int tabOffset)	Returns the next tab stop position after a given reference position.
void	paint(Graphics g, Shape a)	Paints the word-wrapped text.
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.
void	setSize(float width, float height)	Sets the size of the view.
int	viewToModel(float x, float y, Shape a, Position.Bias[] bias)
int	yForLine(Rectangle alloc, int line)
int	yForLineContaining(Rectangle alloc, int offs)

Methods inherited from class BoxView

baselineLayout, baselineRequirements, calculateMajorAxisRequirements, calculateMinorAxisRequirements, childAllocation, flipEastAndWestAtEnds, forwardUpdate, getAlignment, getAxis, getHeight, getOffset, getResizeWeight, getSpan, getWidth, isAfter, isAllocationValid, isBefore, isLayoutValid, layout, layoutChanged, layoutMajorAxis, layoutMinorAxis, paintChild, preferenceChanged, replace, setAxis

Methods inherited from class CompositeView

getBottomInset, getInsideAllocation, getLeftInset, getNextEastWestVisualPositionFrom, getNextNorthSouthVisualPositionFrom, getNextVisualPositionFrom, getRightInset, getTopInset, getView, getViewAtPosition, getViewCount, getViewIndex, getViewIndexAtPosition, setInsets, setParagraphInsets, setParent

Methods inherited from class View

append, breakView, createFragment, forwardUpdateToView, getAttributes, getBreakWeight, getContainer, getDocument, getElement, getEndOffset, getGraphics, getParent, getStartOffset, getToolTipText, getViewFactory, getViewIndex, insert, isVisible, modelToView, remove, removeAll, updateChildren, updateLayout, viewToModel

Methods inherited from class Object

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

Constructor Details

WrappedSyntaxView

public WrappedSyntaxView(Element elem)

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

Parameters:

elem - the element underlying the view

Method Details

calculateBreakPosition

protected int calculateBreakPosition(int p0,
 Token tokenList,
 float x0)

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.

changedUpdate

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

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

Overrides:

changedUpdate in class View

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

See Also:

• View.changedUpdate(DocumentEvent, Shape, ViewFactory)

drawView

protected void drawView(org.fife.ui.rsyntaxtextarea.TokenPainter painter,
 Graphics2D g,
 Rectangle r,
 View view,
 int fontHeight,
 int y,
 int line)

Draws a single view (i.e., a line of text for a wrapped view), wrapping the text onto multiple lines if necessary.

Parameters:

painter - The painter to use to render tokens.

g - The graphics context in which to paint.

r - The rectangle in which to paint.

view - The View to paint.

fontHeight - The height of the font being used.

y - The y-coordinate at which to begin painting.

drawViewWithSelection

protected void drawViewWithSelection(org.fife.ui.rsyntaxtextarea.TokenPainter painter,
 Graphics2D g,
 Rectangle r,
 View view,
 int fontHeight,
 int y,
 int selStart,
 int selEnd)

Draws a single view (i.e., a line of text for a wrapped view), wrapping the text onto multiple lines if necessary. Any selected text is rendered with the editor's "selected text" color.

Parameters:

painter - The painter to use to render tokens.

g - The graphics context in which to paint.

r - The rectangle in which to paint.

view - The View to paint.

fontHeight - The height of the font being used.

y - The y-coordinate at which to begin painting.

selStart - The start of the selection.

selEnd - The end of the selection.

getChildAllocation

public Shape getChildAllocation(int index,
 Shape a)

Fetches the allocation for the given child view.

Overridden to account for code folding.

Overrides:

getChildAllocation in class BoxView

Parameters:

index - The index of the child, >= 0 &&< getViewCount().

a - The allocation to this view

Returns:

The allocation to the child; or null if a is null; or null if the layout is invalid

getChildAllocationImpl

public Shape getChildAllocationImpl(int line,
 Shape a)

Fetches the allocation for the given child view to render into.

Overridden to account for lines hidden by collapsed folded regions.

Parameters:

line - The index of the child, >= 0 &&< getViewCount()

a - The allocation to this view

Returns:

The allocation to the child

getMaximumSpan

public float getMaximumSpan(int axis)

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

Overrides:

getMaximumSpan in class BoxView

Parameters:

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

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.

See Also:

• View.getMaximumSpan(int)

getMinimumSpan

public float getMinimumSpan(int axis)

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

Overrides:

getMinimumSpan in class BoxView

Parameters:

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

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.

See Also:

• View.getMinimumSpan(int)

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

Overrides:

getPreferredSpan in class BoxView

Parameters:

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

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.

See Also:

• View.getPreferredSpan(int)

getTabSize

protected int getTabSize()

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

Returns:

the tab size

getViewAtPoint

protected View getViewAtPoint(int x,
 int y,
 Rectangle alloc)

Overridden to allow for folded regions.

Overrides:

getViewAtPoint in class BoxView

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. This is implemented to simply update the children.

Overrides:

insertUpdate in class View

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

See Also:

• View.insertUpdate(DocumentEvent, Shape, ViewFactory)

loadChildren

protected void loadChildren(ViewFactory f)

Loads all of the children to initialize the view. This is called by the setParent method. Subclasses can re-implement this to initialize their child views in a different manner. The default implementation creates a child view for each child element.

Overrides:

loadChildren in class CompositeView

Parameters:

f - the view factory

modelToView

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

Overrides:

modelToView in class BoxView

Throws:

BadLocationException

modelToView

public Shape modelToView(int p0,
 Position.Bias b0,
 int p1,
 Position.Bias b1,
 Shape a)
                  throws BadLocationException

Provides a mapping, for a given region, from the document model coordinate space to the view coordinate space. The specified region is created as a union of the first and last character positions.

This is implemented to subtract the width of the second character, as this view's modelToView actually returns the width of the character instead of "1" or "0" like the View implementations in javax.swing.text. Thus, if we don't override this method, the View implementation will return one character's width too much for its consumers (implementations of javax.swing.text.Highlighter).

Overrides:

modelToView in class CompositeView

Parameters:

p0 - the position of the first character (>=0)

b0 - The bias of the first character position, toward the previous character or the next character represented by the offset, in case the position is a boundary of two views; b0 will have one of these values:

• Position.Bias.Forward
• Position.Bias.Backward

p1 - the position of the last character (>=0)

b1 - the bias for the second character position, defined one of the legal values shown above

a - the area of the view, which encompasses the requested region

Returns:

the bounding box which is a union of the region specified by the first and last character positions

Throws:

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

IllegalArgumentException - if b0 or b1 are not one of the legal Position.Bias values listed above

See Also:

• View.viewToModel(float, float, Shape, Position.Bias[])

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(Graphics g,
 Shape a)

Paints the word-wrapped text.

Overrides:

paint in class BoxView

Parameters:

g - The graphics context in which to paint.

a - The shape (usually a rectangle) in which to paint.

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. This is implemented to simply update the children.

Overrides:

removeUpdate in class View

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

See Also:

• View.removeUpdate(DocumentEvent, Shape, ViewFactory)

setSize

public void setSize(float width,
 float height)

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

Overrides:

setSize in class BoxView

Parameters:

width - the width >= 0

height - the height >= 0

viewToModel

public int viewToModel(float x,
 float y,
 Shape a,
 Position.Bias[] bias)

Overrides:

viewToModel in class BoxView

yForLine

public int yForLine(Rectangle alloc,
 int line)
             throws BadLocationException

Throws:

BadLocationException

yForLineContaining

public int yForLineContaining(Rectangle alloc,
 int offs)
                       throws BadLocationException

Throws:

BadLocationException