All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class java.awt.swing.text.PlainView 

java.lang.Object
    |
    +----java.awt.swing.text.View
            |
            +----java.awt.swing.text.PlainView
public class PlainView
extends View
implements TabExpander
Implements View interface for a simple multi-line text view that has text in one font and color. The view represents each child element as a line of text.

See Also:
View

Variable Index

o metrics
Font metrics for the currrent font.

Constructor Index

o PlainView(Element)
Constructs a new view wrapped on an element.

Method Index

o changedUpdate(DocumentEvent, Shape, ViewFactory)
Gives notification from the document that attributes were changed in a location that this view is responsible for.
o drawLine(int, Graphics, int, int)
Renders a line of text, suppressing whitespace at the end and exanding any tabs.
o drawSelectedText(Graphics, int, int, int, int)
Render the given range in the model as selected text.
o drawUnselectedText(Graphics, int, int, int, int)
Render the given range in the model as normal unselected text.
o getLineLimit()
Returns the max number of characters per line set for the document,
o getPreferredSpan(int)
Determines the preferred span for this view along an axis.
o getTabSize()
Returns the tab size set for the document, defaulting to 8.
o insertUpdate(DocumentEvent, Shape, ViewFactory)
Gives notification that something was inserted into the document in a location that this view is responsible for.
o modelToView(int, Shape)
Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it.
o nextTabStop(float)
Returns the next tab stop position given a reference position.
o paint(Graphics, Shape)
Renders using the given rendering surface and area on that surface.
o removeUpdate(DocumentEvent, Shape, ViewFactory)
Gives notification that something was removed from the document in a location that this view is responsible for.
o setParent(View)
The parent calls this on the child to tell it who its parent is.
o viewToModel(float, float, Shape)
Provides a mapping from the view coordinate space to the logical coordinate space of the model.

Variables

o metrics 
protected FontMetrics metrics
Font metrics for the currrent font.

Constructors

o PlainView 
public PlainView(Element elem)
Constructs a new view wrapped on an element.

Parameters:
elem - the element

Methods

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

Returns:
the tab size
o getLineLimit 
protected int getLineLimit()
Returns the max number of characters per line set for the document,

Returns:
the max number
o drawLine 
protected void drawLine(int lineIndex,
                        Graphics g,
                        int x,
                        int y)
Renders a line of text, suppressing whitespace at the end and exanding any tabs. This is implemented to make calls to the methods drawUnselected and drawSelected so that the way selected and unselected text are rendered can be customized.

Parameters:
lineIndex - the line to draw
g - the graphics context
x - the starting X position
y - the starting Y position
See Also:
#drawUnselected, #drawSelected
o drawUnselectedText 
protected int drawUnselectedText(Graphics g,
                                 int x,
                                 int y,
                                 int p0,
                                 int p1) throws BadLocationException
Render the given range in the model as normal unselected text.

o drawSelectedText 
protected int drawSelectedText(Graphics g,
                               int x,
                               int y,
                               int p0,
                               int p1) throws BadLocationException
Render 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.

o setParent 
public void setParent(View p)
The parent calls this on the child to tell it who its parent is. If this is null, the view has been removed and we need to remove the associated component from its parent. This is used here to determine what the hosting component is.

Parameters:
p - the parent view
Overrides:
setParent in class View
o getPreferredSpan 
public float getPreferredSpan(int axis)
Determines the preferred span for this view along an axis.

Parameters:
axis - may be either X_AXIS or Y_AXIS
Overrides:
getPreferredSpan in class View
o paint 
public void paint(Graphics g,
                  Shape a)
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 - the rendering surface to use
a - the allocated region to render into
Overrides:
paint in class View
See Also:
paint
o modelToView 
public Shape modelToView(int pos,
                         Shape a) throws BadLocationException
Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it.

Parameters:
pos - the position to convert
a - the allocated region to render into
Returns:
the bounding box of the given position
Throws: BadLocationException
if the given position does not represent a valid location in the associated document
Overrides:
modelToView in class View
See Also:
modelToView
o viewToModel 
public int viewToModel(float fx,
                       float fy,
                       Shape a)
Provides a mapping from the view coordinate space to the logical coordinate space of the model.

Parameters:
fx - the X coordinate
fy - the Y coordinate
a - the allocated region to render into
Returns:
the location within the model that best represents the given point in the view
Overrides:
viewToModel in class View
See Also:
viewToModel
o 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 View
See Also:
insertUpdate
o 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 View
See Also:
removeUpdate
o 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 View
See Also:
changedUpdate
o nextTabStop 
public float nextTabStop(float x)
Returns the next tab stop position given a reference position.

Parameters:
x - the current position
Returns:
the tab stop, measured in points
All Packages  Class Hierarchy  This Package  Previous  Next  Index
Submit a bug or feature