org.antlr.works.ate.swing

Class ATERenderingView

java.lang.Object

javax.swing.text.View

javax.swing.text.PlainView

org.antlr.works.ate.swing.ATERenderingView

All Implemented Interfaces:

SwingConstants, TabExpander

public class ATERenderingView
extends PlainView

This class is responsible to draw each line of the text and apply the appropriate attributes for each token. The idea behind this class has been inspired by the open-source project DrJava: http://drjava.sourceforge.net/

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ATERenderingView.DisplayDelegateOperation Class that knows how to render a portion of text given an array of tokens fetched from a delegate object.
class	ATERenderingView.DisplayOperation Default class that knows how to render a portion of text
class	ATERenderingView.ModelToViewOperation
static interface	ATERenderingView.TextOperation
class	ATERenderingView.ViewToModel

Field Summary

Fields

Modifier and Type	Field and Description
static Color	BACKGROUND_HIGHLIGHT_COLOR
static Font	DEFAULT_FONT

Fields inherited from class javax.swing.text.PlainView

metrics

Fields inherited from class javax.swing.text.View

BadBreakWeight, ExcellentBreakWeight, ForcedBreakWeight, GoodBreakWeight, X_AXIS, Y_AXIS

Fields inherited from interface javax.swing.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 and Description
ATERenderingView(Element elem, ATEPanel textEditor)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	applyAttribute(Graphics g, AttributeSet attribute) This method applies an AttributeSet to a Graphics context
void	close()
protected void	drawLine(int lineIndex, Graphics g, int x, int y) Renders a line of text, suppressing whitespace at the end and expanding any tabs.
protected int	drawSelectedText(Graphics g, int x, int y, int p0, int p1) Renders the given range in the model as selected text.
protected int	drawUnselectedText(Graphics g, int x, int y, int p0, int p1) Renders the given range in the model as normal unselected text.
protected Font	getFontForAttribute(AttributeSet attribute) Return the font given the specified attributes
Shape	modelToView(int pos, Shape a, Position.Bias b) Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it.
void	paint(Graphics g, Shape a)
protected int	renderText(ATERenderingView.TextOperation action, Graphics g, int x, int y, int p0, int p1) This method renders the text using the token information to set up the display attribute of each token.
protected void	restore(Graphics g)
protected void	save(Graphics g)
void	setDelegate(ATERenderingViewDelegate delegate)
int	viewToModel(float fx, float fy, Shape a, Position.Bias[] biasReturn) Provides a mapping from the view coordinate space to the logical coordinate space of the model.

Methods inherited from class javax.swing.text.PlainView

changedUpdate, damageLineRange, getLineBuffer, getPreferredSpan, getTabSize, insertUpdate, lineToRect, nextTabStop, removeUpdate, setSize, updateDamage, updateMetrics

Methods inherited from class javax.swing.text.View

append, breakView, createFragment, forwardUpdate, forwardUpdateToView, getAlignment, getAttributes, getBreakWeight, getChildAllocation, getContainer, getDocument, getElement, getEndOffset, getGraphics, getMaximumSpan, getMinimumSpan, getNextVisualPositionFrom, getParent, getResizeWeight, getStartOffset, getToolTipText, getView, getViewCount, getViewFactory, getViewIndex, getViewIndex, insert, isVisible, modelToView, modelToView, preferenceChanged, remove, removeAll, replace, setParent, updateChildren, updateLayout, viewToModel

Methods inherited from class java.lang.Object

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

Field Detail

BACKGROUND_HIGHLIGHT_COLOR

public static final Color BACKGROUND_HIGHLIGHT_COLOR

DEFAULT_FONT

public static Font DEFAULT_FONT

Constructor Detail

ATERenderingView

public ATERenderingView(Element elem,
                ATEPanel textEditor)

Method Detail

setDelegate

public void setDelegate(ATERenderingViewDelegate delegate)

close

public void close()

drawLine

protected void drawLine(int lineIndex,
            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.

Overrides:

drawLine in class PlainView

Parameters:

lineIndex - the line to draw >= 0

g - the Graphics context

x - the starting X position >= 0

y - the starting Y position >= 0

See Also:

drawUnselectedText(java.awt.Graphics, int, int, int, int), drawSelectedText(java.awt.Graphics, int, int, int, int)

modelToView

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

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

Overrides:

modelToView in class PlainView

Throws:

BadLocationException

viewToModel

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

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

Overrides:

viewToModel in class PlainView

paint

public void paint(Graphics g,
         Shape a)

Overrides:

paint in class PlainView

drawUnselectedText

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

Renders the given range in the model as normal unselected text. Uses the foreground or disabled color to render the text.

Overrides:

drawUnselectedText in class PlainView

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 >= 0

Returns:

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

Throws:

BadLocationException - if the range is invalid

drawSelectedText

protected int drawSelectedText(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.

Overrides:

drawSelectedText in class PlainView

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 >= 0

Returns:

the location of the end of the range

Throws:

BadLocationException - if the range is invalid

renderText

protected int renderText(ATERenderingView.TextOperation action,
             Graphics g,
             int x,
             int y,
             int p0,
             int p1)
                  throws BadLocationException

This method renders the text using the token information to set up the display attribute of each token.

Throws:

BadLocationException

applyAttribute

protected void applyAttribute(Graphics g,
                  AttributeSet attribute)

This method applies an AttributeSet to a Graphics context

Parameters:

g - The graphic context

attribute - The attribute to apply

getFontForAttribute

protected Font getFontForAttribute(AttributeSet attribute)

Return the font given the specified attributes

Parameters:

attribute - The font attributes

Returns:

The font given the specified attributes

save

protected void save(Graphics g)

restore

protected void restore(Graphics g)