GlyphView JDK 1.6)

Methods

public void append (View v) [Inherited From View]

Appends a single child view.

Appends a single child view. This is a convenience
call to replace.
Parameters:
- v - the view
Since: 1.3
See Also: View.replace(int, int, javax.swing.text.View[]),

public View breakView (int axis, int p0, float pos, float len) [Overrides View]

Breaks this view on the given axis at the given length.

public void changedUpdate (DocumentEvent e, Shape a, ViewFactory f) [Overrides View]

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

protected void checkPainter ()

Check to see that a glyph painter exists.

protectedfinal Object clone ()

Creates a shallow copy.

public View createFragment (int p0, int p1) [Overrides View]

Creates a view that represents a portion of the element.

protected void forwardUpdate (ElementChange ec, DocumentEvent e, Shape a, ViewFactory f) [Inherited From View]

Forwards the given DocumentEvent to the child views that need to be notified of the change to the model.

Forwards the given DocumentEvent to the child views
that need to be notified of the change to the model.
If there were changes to the element this view is
responsible for, that should be considered when
forwarding (i.e. new child views should not get
notified).
Parameters:
- ec - changes to the element this view is responsible for (may be null if there were no changes).
- 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
Since: 1.3
See Also: View.insertUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory), View.removeUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory), View.changedUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory),

protected void forwardUpdateToView (View v, DocumentEvent e, Shape a, ViewFactory f) [Inherited From View]

Forwards the DocumentEvent to the give child view.

Forwards the DocumentEvent to the give child view. This
simply messages the view with a call to insertUpdate,
removeUpdate, or changedUpdate depending
upon the type of the event. This is called by
forwardUpdate to forward
the event to children that need it.
Parameters:
- v - the child view to forward the event to
- 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
Since: 1.3
See Also:

View.forwardUpdate(javax.swing.event.DocumentEvent.ElementChange, javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory)

public float getAlignment (int axis) [Overrides View]

Determines the desired alignment for this view along an axis.

public AttributeSet getAttributes () [Inherited From View]

Fetches the attributes to use when rendering.

Fetches the attributes to use when rendering. By default
this simply returns the attributes of the associated element.
This method should be used rather than using the element
directly to obtain access to the attributes to allow
view-specific attributes to be mixed in or to allow the
view to have view-specific conversion of attributes by
subclasses.
Each view should document what attributes it recognizes
for the purpose of rendering or layout, and should always
access them through the AttributeSet returned
by this method.

public Color getBackground ()

Fetch the background color to use to render the glyphs.

Fetch the background color to use to render the
glyphs. If there is no background color, null should
be returned. This is implemented to call
StyledDocument.getBackground if the associated
document is a styled document, otherwise it returns null.

public int getBreakWeight (int axis, float pos, float len) [Overrides View]

Determines how attractive a break opportunity in this view is.

Determines how attractive a break opportunity in this view is. This can be used for determining which view is the most attractive to call breakView on in the process of formatting. The higher the weight, the more attractive the break. A value equal to or lower than View.BadBreakWeight should not be considered for a break. A value greater than or equal to View.ForcedBreakWeight should be broken.

This is implemented to forward to the superclass for the Y_AXIS. Along the X_AXIS the following values may be returned.

View.ExcellentBreakWeight: if there is whitespace proceeding the desired break location.
View.BadBreakWeight: if the desired break location results in a break location of the starting offset.
View.GoodBreakWeight: if the other conditions don't occur.

This will normally result in the behavior of breaking on a whitespace location if one can be found, otherwise breaking between characters.
Returns: the weight, which should be a value between View.ForcedBreakWeight and View.BadBreakWeight.
Parameters:
- axis - may be either View.X_AXIS or View.Y_AXIS
- pos - the potential location of the start of the broken view >= 0. This may be useful for calculating tab positions.
- len - specifies the relative length from pos where a potential break is desired >= 0.
See Also: LabelView, ParagraphView, View.BadBreakWeight, View.GoodBreakWeight, View.ExcellentBreakWeight, View.ForcedBreakWeight,

public Shape getChildAllocation (int index, Shape a) [Inherited From View]

Fetches the allocation for the given child view.

Fetches the allocation for the given child view.
This enables finding out where various views
are located, without assuming how the views store
their location. This returns null since the
default is to not have any child views.
Returns: the allocation to the child
Parameters:
- index - the index of the child, >= 0 && < getViewCount()
- a - the allocation to this view

public Container getContainer () [Inherited From View]

Fetches the container hosting the view.

Fetches the container hosting the view. This is useful for
things like scheduling a repaint, finding out the host
components font, etc. The default implementation
of this is to forward the query to the parent view.
Returns: the container, null if none

public Document getDocument () [Inherited From View]

Fetches the model associated with the view.

Fetches the model associated with the view.
Returns: the view model, null if none
See Also: View.getDocument(),

public Element getElement () [Inherited From View]

Fetches the structural portion of the subject that this view is mapped to.

public int getEndOffset () [Overrides View]

Fetches the portion of the model that this view is responsible for.

public Font getFont ()

Fetch the font that the glyphs should be based upon.

Fetch the font that the glyphs should be based
upon. This is implemented to call
StyledDocument.getFont if the associated
document is a StyledDocument. If the associated document
is not a StyledDocument, the associated components font
is used. If there is no associated component, null
is returned.

public Color getForeground ()

Fetch the foreground color to use to render the glyphs.

Fetch the foreground color to use to render the
glyphs. If there is no foreground color, null should
be returned. This is implemented to call
StyledDocument.getBackground if the associated
document is a StyledDocument. If the associated document
is not a StyledDocument, the associated components foreground
color is used. If there is no associated component, null
is returned.

public GlyphPainter getGlyphPainter ()

Fetch the currently installed glyph painter.

public Graphics getGraphics () [Inherited From View]

Fetch a Graphics for rendering.

Fetch a Graphics for rendering.
This can be used to determine
font characteristics, and will be different for a print view
than a component view.
Returns: a Graphics object for rendering
Since: 1.3

pack-private JustificationInfo getJustificationInfo (int rowStartOffset)

public float getMaximumSpan (int axis) [Inherited From View]

Determines the maximum span for this view along an axis.

Determines the maximum span for this view along an
axis.
Returns: the maximum span the view can be rendered into
Parameters:
- axis - may be either View.X_AXIS or View.Y_AXIS
See Also: View.getPreferredSpan(int),

public float getMinimumSpan (int axis) [Inherited From View]

Determines the minimum span for this view along an axis.

Determines the minimum span for this view along an
axis.
Returns: the minimum span the view can be rendered into
Parameters:
- axis - may be either View.X_AXIS or View.Y_AXIS
See Also: View.getPreferredSpan(int),

public int getNextVisualPositionFrom (int pos, Bias b, Shape a, int direction, Bias biasRet) throws BadLocationException [Overrides View]

Provides a way to determine the next visually represented model location that one might place a caret.

public View getParent () [Inherited From View]

Returns the parent of the view.

Returns the parent of the view.
Returns: the parent, or null if none exists

public float getPartialSpan (int p0, int p1) [Specified in TabableView]

Determines the span along the same axis as tab expansion for a portion of the view.

public float getPreferredSpan (int axis) [Specified in View]

Determines the preferred span for this view along an axis.

public int getResizeWeight (int axis) [Inherited From View]

Determines the resizability of the view along the given axis.

Determines the resizability of the view along the
given axis. A value of 0 or less is not resizable.
Returns: the weight
Parameters:
- axis - may be either View.X_AXIS or View.Y_AXIS

public int getStartOffset () [Overrides View]

Fetches the portion of the model that this view is responsible for.

public float getTabbedSpan (float x, TabExpander e) [Specified in TabableView]

Determines the desired span when using the given tab expansion implementation.

public TabExpander getTabExpander ()

Fetch the TabExpander to use if tabs are present in this view.

public Segment getText (int p0, int p1)

Fetch a reference to the text that occupies the given range.

Fetch a reference to the text that occupies
the given range. This is normally used by
the GlyphPainter to determine what characters
it should render glyphs for.
Returns: the Segment containing the text
Parameters:
- p0 - the starting document offset >= 0
- p1 - the ending document offset >= p0

public String getToolTipText (float x, float y, Shape allocation) [Inherited From View]

Returns the tooltip text at the specified location.

public View getView (int n) [Inherited From View]

Gets the nth child view.

Gets the nth child view. Since there are no
children by default, this returns null.
Returns: the view
Parameters:
- n - the number of the view to get, >= 0 && < getViewCount()

public int getViewCount () [Inherited From View]

Returns the number of views in this view.

public ViewFactory getViewFactory () [Inherited From View]

Fetches the ViewFactory implementation that is feeding the view hierarchy.

Fetches the ViewFactory implementation that is feeding
the view hierarchy. Normally the views are given this
as an argument to updates from the model when they
are most likely to need the factory, but this
method serves to provide it at other times.
Returns: the factory, null if none

public int getViewIndex (float x, float y, Shape allocation) [Inherited From View]

Returns the child view index representing the given position in the view.

Returns the child view index representing the given position in
the view. This iterates over all the children returning the
first with a bounds that contains x, y.
Returns: index of the view representing the given location, or -1 if no view represents that position
Parameters:
- x - the x coordinate
- y - the y coordinate
- allocation - current allocation of the View.
Since: 1.4

public int getViewIndex (int pos, Bias b) [Inherited From View]

Returns the child view index representing the given position in the model.

public void insert (int offs, View v) [Inherited From View]

Inserts a single child view.

Inserts a single child view. This is a convenience
call to replace.
Parameters:
- offs - the offset of the view to insert before >= 0
- v - the view
Since: 1.3
See Also: View.replace(int, int, javax.swing.text.View[]),

public void insertUpdate (DocumentEvent e, Shape a, ViewFactory f) [Overrides View]

Gives notification that something was inserted into the document in a location that this view is responsible for.

public boolean isStrikeThrough ()

Determine if the glyphs should have a strikethrough line.

public boolean isSubscript ()

Determine if the glyphs should be rendered as superscript.

public boolean isSuperscript ()

Determine if the glyphs should be rendered as subscript.

public boolean isUnderline ()

Determine if the glyphs should be underlined.

public boolean isVisible () [Inherited From View]

Returns a boolean that indicates whether the view is visible or not.

public Shape modelToView (int p0, Bias b0, int p1, Bias b1, Shape a) throws BadLocationException [Inherited From View]

Provides a mapping, for a given region, from the document model coordinate space to the view coordinate space.

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.
Returns: the bounding box which is a union of the region specified by the first and last character positions
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
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, java.awt.Shape, javax.swing.text.Position.Bias[]),

@Deprecated

public Shape ~~modelToView~~ (int pos, Shape a) throws BadLocationException [Inherited From View]

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

Provides a mapping from the document model coordinate space
to the coordinate space of the view mapped to it. This is
implemented to default the bias to Position.Bias.Forward
which was previously implied.
Returns: the bounding box of the given position is returned
Parameters:
- pos - the position to convert >= 0
- a - the allocated region in which to render
Throws:
- BadLocationException - if the given position does not represent a valid location in the associated document
See Also: View.modelToView(int, java.awt.Shape, javax.swing.text.Position.Bias),

public Shape modelToView (int pos, Shape a, Bias b) throws BadLocationException [Specified in View]

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

Provides a mapping from the document model coordinate space
to the coordinate space of the view mapped to it.
Returns: the bounding box of the given position
Parameters:
- pos - the position to convert >= 0
- a - the allocated region to render into
- b - either Position.Bias.Forward or Position.Bias.Backward
Throws:
- BadLocationException - if the given position does not represent a valid location in the associated document
See Also: View.modelToView(int, java.awt.Shape, javax.swing.text.Position.Bias),

public void paint (Graphics g, Shape a) [Specified in View]

Renders a portion of a text style run.

pack-privatefinal void paintTextUsingColor (Graphics g, Shape a, Color c, int p0, int p1)

Paints the specified region of text in the specified color.

public void preferenceChanged (View child, boolean width, boolean height) [Inherited From View]

Child views can call this on the parent to indicate that the preference has changed and should be reconsidered for layout.

Child views can call this on the parent to indicate that
the preference has changed and should be reconsidered
for layout. By default this just propagates upward to
the next parent. The root view will call
revalidate on the associated text component.
Parameters:
- child - the child view
- width - true if the width preference has changed
- height - true if the height preference has changed
See Also: JComponent.revalidate(),

public void remove (int i) [Inherited From View]

Removes one of the children at the given position.

Removes one of the children at the given position.
This is a convenience call to replace.
Since: 1.3

public void removeAll () [Inherited From View]

Removes all of the children.

Removes all of the children. This is a convenience
call to replace.
Since: 1.3

public void removeUpdate (DocumentEvent e, Shape a, ViewFactory f) [Overrides View]

Gives notification that something was removed from the document in a location that this view is responsible for.

public void replace (int offset, int length, View views) [Inherited From View]

Replaces child views.

Replaces child views. If there are no views to remove
this acts as an insert. If there are no views to
add this acts as a remove. Views being removed will
have the parent set to null, and the internal reference
to them removed so that they can be garbage collected.
This is implemented to do nothing, because by default
a view has no children.
Parameters:
- offset - the starting index into the child views to insert the new views. This should be a value >= 0 and <= getViewCount
- length - the number of existing child views to remove This should be a value >= 0 and <= (getViewCount() - offset).
- views - the child views to add. This value can be null to indicate no children are being added (useful to remove).
Since: 1.3

public void setGlyphPainter (GlyphPainter p)

Sets the painter to use for rendering glyphs.

public void setParent (View parent) [Inherited From View]

Establishes the parent view for this view.

Establishes the parent view for this view. This is
guaranteed to be called before any other methods if the
parent view is functioning properly. This is also
the last method called, since it is called to indicate
the view has been removed from the hierarchy as
well. When this method is called to set the parent to
null, this method does the same for each of its children,
propogating the notification that they have been
disconnected from the view tree. If this is
reimplemented, super.setParent() should
be called.
Parameters:
- parent - the new parent, or null if the view is being removed from a parent

public void setSize (float width, float height) [Inherited From View]

Sets the size of the view.

protected boolean updateChildren (ElementChange ec, DocumentEvent e, ViewFactory f) [Inherited From View]

Updates the child views in response to receiving notification that the model changed, and there is change record for the element this view is responsible for.

Updates the child views in response to receiving notification
that the model changed, and there is change record for the
element this view is responsible for. This is implemented
to assume the child views are directly responsible for the
child elements of the element this view represents. The
ViewFactory is used to create child views for each element
specified as added in the ElementChange, starting at the
index specified in the given ElementChange. The number of
child views representing the removed elements specified are
removed.
Returns: whether or not the child views represent the child elements of the element this view is responsible for. Some views create children that represent a portion of the element they are responsible for, and should return false. This information is used to determine if views in the range of the added elements should be forwarded to or not
Parameters:
- ec - the change information for the element this view is responsible for. This should not be null if this method gets called
- e - the change information from the associated document
- f - the factory to use to build child views
Since: 1.3
See Also: View.insertUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory), View.removeUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory), View.changedUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory),

protected void updateLayout (ElementChange ec, DocumentEvent e, Shape a) [Inherited From View]

Updates the layout in response to receiving notification of change from the model.

Updates the layout in response to receiving notification of
change from the model. This is implemented to call
preferenceChanged to reschedule a new layout
if the ElementChange record is not null.
Parameters:
- ec - changes to the element this view is responsible for (may be null if there were no changes)
- e - the change information from the associated document
- a - the current allocation of the view
Since: 1.3
See Also: View.insertUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory), View.removeUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory), View.changedUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory),

@Deprecated

public int ~~viewToModel~~ (float x, float y, Shape a) [Inherited From View]

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

public int viewToModel (float x, float y, Shape a, Bias biasReturn) [Specified in View]

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

Provides a mapping from the view coordinate space to the logical
coordinate space of the model.
Returns: the location within the model that best represents the given point of view >= 0
Parameters:
- x - the X coordinate >= 0
- y - the Y coordinate >= 0
- a - the allocated region to render into
- biasReturn - either Position.Bias.Forward or Position.Bias.Backward is returned as the zero-th element of this array
See Also: View.viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[]),