public class javax.swing.text
PlainView


Show All Login
Java SE 6
  
Extends: View
Implements: TabExpander
Extended by: FieldView
Details
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.
version1.77 04/07/06
See also javax.swing.text.View

Fields
protected FontMetrics metrics
Font metrics for the current font.

Constructors
public PlainView(Element elem) Details
Constructs a new PlainView wrapped on an element.
elemthe element

Methods
public void changedUpdate(DocumentEvent changes, Shape a, ViewFactory f) Details
Gives notification from the document that attributes were changed in a location that this view is responsible for.
changesthe change information from the associated document
athe current allocation of the view
fthe factory to use to rebuild if the view has children
See also changedUpdate
protected void damageLineRange(int line0, int line1, Shape a, Component host) Details
Repaint the given line range.
hostthe component hosting the view (used to call repaint)
athe region allocated for the view to render into
line0the starting line number to repaint. This must be a valid line number in the model.
line1the ending line number to repaint. This must be a valid line number in the model.
since1.4
protected void drawLine(int lineIndex, Graphics g, int x, int y) Details
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.
lineIndexthe line to draw >= 0the line to draw >= 0
gthe Graphics context
xthe starting X position >= 0the starting X position >= 0
ythe starting Y position >= 0the starting Y position >= 0
See also drawUnselectedText, drawSelectedText
protected int drawSelectedText(Graphics g, int x, int y, int p0, int p1) throws BadLocationException Details
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.
gthe graphics context
xthe starting X coordinate >= 0the starting X coordinate >= 0
ythe starting Y coordinate >= 0the starting Y coordinate >= 0
p0the beginning position in the model >= 0the beginning position in the model >= 0
p1the ending position in the model >= 0the ending position in the model >= 0
returnthe location of the end of the range
ThrowsBadLocationException: if the range is invalid
protected int drawUnselectedText(Graphics g, int x, int y, int p0, int p1) throws BadLocationException Details
Renders the given range in the model as normal unselected text. Uses the foreground or disabled color to render the text.
gthe graphics context
xthe starting X coordinate >= 0the starting X coordinate >= 0
ythe starting Y coordinate >= 0the starting Y coordinate >= 0
p0the beginning position in the model >= 0the beginning position in the model >= 0
p1the ending position in the model >= 0the ending position in the model >= 0
returnthe X location of the end of the range >= 0the X location of the end of the range >= 0
ThrowsBadLocationException: if the range is invalid
public void insertUpdate(DocumentEvent changes, Shape a, ViewFactory f) Details
Gives notification that something was inserted into the document in a location that this view is responsible for.
changesthe change information from the associated document
athe current allocation of the view
fthe factory to use to rebuild if the view has children
See also insertUpdate
protected Rectangle lineToRect(Shape a, int line) Details
Determine the rectangle that represents the given line.
athe region allocated for the view to render into
linethe line number to find the region of. This must be a valid line number in the model.
since1.4
public Shape modelToView(int pos, Shape a, Position.Bias b) throws BadLocationException Details
Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it.
posthe position to convert >= 0the position to convert >= 0
athe allocated region to render into
returnthe bounding box of the given position
ThrowsBadLocationException: if the given position does not represent a valid location in the associated document
See also modelToView
public float nextTabStop(float x, int tabOffset) Details
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.
xthe current position >= 0the current position >= 0
tabOffsetthe position within the text stream that the tab occurred at >= 0.
returnthe tab stop, measured in points >= 0the tab stop, measured in points >= 0
public void paint(Graphics g, Shape a) Details
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.
gthe rendering surface to use
athe allocated region to render into
See also paint
public void removeUpdate(DocumentEvent changes, Shape a, ViewFactory f) Details
Gives notification that something was removed from the document in a location that this view is responsible for.
changesthe change information from the associated document
athe current allocation of the view
fthe factory to use to rebuild if the view has children
See also removeUpdate
protected void updateDamage(DocumentEvent changes, Shape a, ViewFactory f) Details
Repaint the region of change covered by the given document event. Damages the line that begins the range to cover the case when the insert/remove is only on one line. If lines are added or removed, damages the whole view. The longest line is checked to see if it has changed.
since1.4
protected void updateMetrics() Details
Checks to see if the font metrics and longest line are up-to-date.
since1.4
public int viewToModel(float fx, float fy, Shape a, Position.Bias[] bias) Details
Provides a mapping from the view coordinate space to the logical coordinate space of the model.
fxthe X coordinate >= 0the X coordinate >= 0
fythe Y coordinate >= 0the Y coordinate >= 0
athe allocated region to render into
returnthe location within the model that best represents the given point in the view >= 0
See also viewToModel

Properties
final protected Segment getLineBuffer() Details
Gives access to a buffer that can be used to fetch text from the associated document.
returnthe buffer
public float getPreferredSpan(int axis) Details
Determines the preferred span for this view along an axis.
axismay be either View.X_AXIS or View.Y_AXIS
returnthe span the view would like to be rendered into >= 0. 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.the span the view would like to be rendered into >= 0. 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.
ThrowsIllegalArgumentException: for an invalid axis
public void setSize(float width, float height) Details
Sets the size of the view. This should cause layout of the view along the given axis, if it has any layout duties.
widththe width >= 0the width >= 0
heightthe height >= 0the height >= 0
protected int getTabSize() Details
Returns the tab size set for the document, defaulting to 8.
returnthe tab size