javax.swing.text
Class GlyphView

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by javax.swing.text.View sample code for javax.swing.text.View definition code for javax.swing.text.View 
      extended by javax.swing.text.GlyphView
All Implemented Interfaces:
Cloneable sample code for java.lang.Cloneable definition code for java.lang.Cloneable , SwingConstants sample code for javax.swing.SwingConstants definition code for javax.swing.SwingConstants , TabableView sample code for javax.swing.text.TabableView definition code for javax.swing.text.TabableView
Direct Known Subclasses:
LabelView sample code for javax.swing.text.LabelView definition code for javax.swing.text.LabelView

public class GlyphView
extends View sample code for javax.swing.text.View definition code for javax.swing.text.View
implements TabableView sample code for javax.swing.text.TabableView definition code for javax.swing.text.TabableView , Cloneable sample code for java.lang.Cloneable definition code for java.lang.Cloneable

A GlyphView is a styled chunk of text that represents a view mapped over an element in the text model. This view is generally responsible for displaying text glyphs using character level attributes in some way. An implementation of the GlyphPainter class is used to do the actual rendering and model/view translations. This separates rendering from layout and management of the association with the model.

The view supports breaking for the purpose of formatting. The fragments produced by breaking share the view that has primary responsibility for the element (i.e. they are nested classes and carry only a small amount of state of their own) so they can share its resources.

Since this view represents text that may have tabs embedded in it, it implements the TabableView interface. Tabs will only be expanded if this view is embedded in a container that does tab expansion. ParagraphView is an example of a container that does tab expansion.

Since:
1.3

Nested Class Summary
static class GlyphView.GlyphPainter sample code for javax.swing.text.GlyphView.GlyphPainter definition code for javax.swing.text.GlyphView.GlyphPainter
          A class to perform rendering of the glyphs.
 
Field Summary
 
Fields inherited from class javax.swing.text.View sample code for javax.swing.text.View definition code for javax.swing.text.View
BadBreakWeight sample code for javax.swing.text.View.BadBreakWeight definition code for javax.swing.text.View.BadBreakWeight , ExcellentBreakWeight sample code for javax.swing.text.View.ExcellentBreakWeight definition code for javax.swing.text.View.ExcellentBreakWeight , ForcedBreakWeight sample code for javax.swing.text.View.ForcedBreakWeight definition code for javax.swing.text.View.ForcedBreakWeight , GoodBreakWeight sample code for javax.swing.text.View.GoodBreakWeight definition code for javax.swing.text.View.GoodBreakWeight , X_AXIS sample code for javax.swing.text.View.X_AXIS definition code for javax.swing.text.View.X_AXIS , Y_AXIS sample code for javax.swing.text.View.Y_AXIS definition code for javax.swing.text.View.Y_AXIS
 
Fields inherited from interface javax.swing.SwingConstants sample code for javax.swing.SwingConstants definition code for javax.swing.SwingConstants
BOTTOM sample code for javax.swing.SwingConstants.BOTTOM definition code for javax.swing.SwingConstants.BOTTOM , CENTER sample code for javax.swing.SwingConstants.CENTER definition code for javax.swing.SwingConstants.CENTER , EAST sample code for javax.swing.SwingConstants.EAST definition code for javax.swing.SwingConstants.EAST , HORIZONTAL sample code for javax.swing.SwingConstants.HORIZONTAL definition code for javax.swing.SwingConstants.HORIZONTAL , LEADING sample code for javax.swing.SwingConstants.LEADING definition code for javax.swing.SwingConstants.LEADING , LEFT sample code for javax.swing.SwingConstants.LEFT definition code for javax.swing.SwingConstants.LEFT , NEXT sample code for javax.swing.SwingConstants.NEXT definition code for javax.swing.SwingConstants.NEXT , NORTH sample code for javax.swing.SwingConstants.NORTH definition code for javax.swing.SwingConstants.NORTH , NORTH_EAST sample code for javax.swing.SwingConstants.NORTH_EAST definition code for javax.swing.SwingConstants.NORTH_EAST , NORTH_WEST sample code for javax.swing.SwingConstants.NORTH_WEST definition code for javax.swing.SwingConstants.NORTH_WEST , PREVIOUS sample code for javax.swing.SwingConstants.PREVIOUS definition code for javax.swing.SwingConstants.PREVIOUS , RIGHT sample code for javax.swing.SwingConstants.RIGHT definition code for javax.swing.SwingConstants.RIGHT , SOUTH sample code for javax.swing.SwingConstants.SOUTH definition code for javax.swing.SwingConstants.SOUTH , SOUTH_EAST sample code for javax.swing.SwingConstants.SOUTH_EAST definition code for javax.swing.SwingConstants.SOUTH_EAST , SOUTH_WEST sample code for javax.swing.SwingConstants.SOUTH_WEST definition code for javax.swing.SwingConstants.SOUTH_WEST , TOP sample code for javax.swing.SwingConstants.TOP definition code for javax.swing.SwingConstants.TOP , TRAILING sample code for javax.swing.SwingConstants.TRAILING definition code for javax.swing.SwingConstants.TRAILING , VERTICAL sample code for javax.swing.SwingConstants.VERTICAL definition code for javax.swing.SwingConstants.VERTICAL , WEST sample code for javax.swing.SwingConstants.WEST definition code for javax.swing.SwingConstants.WEST
 
Constructor Summary
GlyphView sample code for javax.swing.text.GlyphView.GlyphView(javax.swing.text.Element) definition code for javax.swing.text.GlyphView.GlyphView(javax.swing.text.Element) (Element sample code for javax.swing.text.Element definition code for javax.swing.text.Element  elem)
          Constructs a new view wrapped on an element.
 
Method Summary
 View sample code for javax.swing.text.View definition code for javax.swing.text.View breakView sample code for javax.swing.text.GlyphView.breakView(int, int, float, float) definition code for javax.swing.text.GlyphView.breakView(int, int, float, float) (int axis, int p0, float pos, float len)
          Breaks this view on the given axis at the given length.
 void changedUpdate sample code for javax.swing.text.GlyphView.changedUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) definition code for javax.swing.text.GlyphView.changedUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) (DocumentEvent sample code for javax.swing.event.DocumentEvent definition code for javax.swing.event.DocumentEvent  e, Shape sample code for java.awt.Shape definition code for java.awt.Shape  a, ViewFactory sample code for javax.swing.text.ViewFactory definition code for javax.swing.text.ViewFactory  f)
          Gives notification from the document that attributes were changed in a location that this view is responsible for.
protected  void checkPainter sample code for javax.swing.text.GlyphView.checkPainter() definition code for javax.swing.text.GlyphView.checkPainter() ()
          Check to see that a glyph painter exists.
protected  Object sample code for java.lang.Object definition code for java.lang.Object clone sample code for javax.swing.text.GlyphView.clone() definition code for javax.swing.text.GlyphView.clone() ()
          Creates a shallow copy.
 View sample code for javax.swing.text.View definition code for javax.swing.text.View createFragment sample code for javax.swing.text.GlyphView.createFragment(int, int) definition code for javax.swing.text.GlyphView.createFragment(int, int) (int p0, int p1)
          Creates a view that represents a portion of the element.
 float getAlignment sample code for javax.swing.text.GlyphView.getAlignment(int) definition code for javax.swing.text.GlyphView.getAlignment(int) (int axis)
          Determines the desired alignment for this view along an axis.
 Color sample code for java.awt.Color definition code for java.awt.Color getBackground sample code for javax.swing.text.GlyphView.getBackground() definition code for javax.swing.text.GlyphView.getBackground() ()
          Fetch the background color to use to render the glyphs.
 int getBreakWeight sample code for javax.swing.text.GlyphView.getBreakWeight(int, float, float) definition code for javax.swing.text.GlyphView.getBreakWeight(int, float, float) (int axis, float pos, float len)
          Determines how attractive a break opportunity in this view is.
 int getEndOffset sample code for javax.swing.text.GlyphView.getEndOffset() definition code for javax.swing.text.GlyphView.getEndOffset() ()
          Fetches the portion of the model that this view is responsible for.
 Font sample code for java.awt.Font definition code for java.awt.Font getFont sample code for javax.swing.text.GlyphView.getFont() definition code for javax.swing.text.GlyphView.getFont() ()
          Fetch the font that the glyphs should be based upon.
 Color sample code for java.awt.Color definition code for java.awt.Color getForeground sample code for javax.swing.text.GlyphView.getForeground() definition code for javax.swing.text.GlyphView.getForeground() ()
          Fetch the foreground color to use to render the glyphs.
 GlyphView.GlyphPainter sample code for javax.swing.text.GlyphView.GlyphPainter definition code for javax.swing.text.GlyphView.GlyphPainter getGlyphPainter sample code for javax.swing.text.GlyphView.getGlyphPainter() definition code for javax.swing.text.GlyphView.getGlyphPainter() ()
          Fetch the currently installed glyph painter.
 int getNextVisualPositionFrom sample code for javax.swing.text.GlyphView.getNextVisualPositionFrom(int, javax.swing.text.Position.Bias, java.awt.Shape, int, javax.swing.text.Position.Bias[]) definition code for javax.swing.text.GlyphView.getNextVisualPositionFrom(int, javax.swing.text.Position.Bias, java.awt.Shape, int, javax.swing.text.Position.Bias[]) (int pos, Position.Bias sample code for javax.swing.text.Position.Bias definition code for javax.swing.text.Position.Bias  b, Shape sample code for java.awt.Shape definition code for java.awt.Shape  a, int direction, Position.Bias sample code for javax.swing.text.Position.Bias definition code for javax.swing.text.Position.Bias [] biasRet)
          Provides a way to determine the next visually represented model location that one might place a caret.
 float getPartialSpan sample code for javax.swing.text.GlyphView.getPartialSpan(int, int) definition code for javax.swing.text.GlyphView.getPartialSpan(int, int) (int p0, int p1)
          Determines the span along the same axis as tab expansion for a portion of the view.
 float getPreferredSpan sample code for javax.swing.text.GlyphView.getPreferredSpan(int) definition code for javax.swing.text.GlyphView.getPreferredSpan(int) (int axis)
          Determines the preferred span for this view along an axis.
 int getStartOffset sample code for javax.swing.text.GlyphView.getStartOffset() definition code for javax.swing.text.GlyphView.getStartOffset() ()
          Fetches the portion of the model that this view is responsible for.
 float getTabbedSpan sample code for javax.swing.text.GlyphView.getTabbedSpan(float, javax.swing.text.TabExpander) definition code for javax.swing.text.GlyphView.getTabbedSpan(float, javax.swing.text.TabExpander) (float x, TabExpander sample code for javax.swing.text.TabExpander definition code for javax.swing.text.TabExpander  e)
          Determines the desired span when using the given tab expansion implementation.
 TabExpander sample code for javax.swing.text.TabExpander definition code for javax.swing.text.TabExpander getTabExpander sample code for javax.swing.text.GlyphView.getTabExpander() definition code for javax.swing.text.GlyphView.getTabExpander() ()
          Fetch the TabExpander to use if tabs are present in this view.
 Segment sample code for javax.swing.text.Segment definition code for javax.swing.text.Segment getText sample code for javax.swing.text.GlyphView.getText(int, int) definition code for javax.swing.text.GlyphView.getText(int, int) (int p0, int p1)
          Fetch a reference to the text that occupies the given range.
 void insertUpdate sample code for javax.swing.text.GlyphView.insertUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) definition code for javax.swing.text.GlyphView.insertUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) (DocumentEvent sample code for javax.swing.event.DocumentEvent definition code for javax.swing.event.DocumentEvent  e, Shape sample code for java.awt.Shape definition code for java.awt.Shape  a, ViewFactory sample code for javax.swing.text.ViewFactory definition code for javax.swing.text.ViewFactory  f)
          Gives notification that something was inserted into the document in a location that this view is responsible for.
 boolean isStrikeThrough sample code for javax.swing.text.GlyphView.isStrikeThrough() definition code for javax.swing.text.GlyphView.isStrikeThrough() ()
          Determine if the glyphs should have a strikethrough line.
 boolean isSubscript sample code for javax.swing.text.GlyphView.isSubscript() definition code for javax.swing.text.GlyphView.isSubscript() ()
          Determine if the glyphs should be rendered as superscript.
 boolean isSuperscript sample code for javax.swing.text.GlyphView.isSuperscript() definition code for javax.swing.text.GlyphView.isSuperscript() ()
          Determine if the glyphs should be rendered as subscript.
 boolean isUnderline sample code for javax.swing.text.GlyphView.isUnderline() definition code for javax.swing.text.GlyphView.isUnderline() ()
          Determine if the glyphs should be underlined.
 Shape sample code for java.awt.Shape definition code for java.awt.Shape modelToView sample code for javax.swing.text.GlyphView.modelToView(int, java.awt.Shape, javax.swing.text.Position.Bias) definition code for javax.swing.text.GlyphView.modelToView(int, java.awt.Shape, javax.swing.text.Position.Bias) (int pos, Shape sample code for java.awt.Shape definition code for java.awt.Shape  a, Position.Bias sample code for javax.swing.text.Position.Bias definition code for javax.swing.text.Position.Bias  b)
          Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it.
 void paint sample code for javax.swing.text.GlyphView.paint(java.awt.Graphics, java.awt.Shape) definition code for javax.swing.text.GlyphView.paint(java.awt.Graphics, java.awt.Shape) (Graphics sample code for java.awt.Graphics definition code for java.awt.Graphics  g, Shape sample code for java.awt.Shape definition code for java.awt.Shape  a)
          Renders a portion of a text style run.
 void removeUpdate sample code for javax.swing.text.GlyphView.removeUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) definition code for javax.swing.text.GlyphView.removeUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) (DocumentEvent sample code for javax.swing.event.DocumentEvent definition code for javax.swing.event.DocumentEvent  e, Shape sample code for java.awt.Shape definition code for java.awt.Shape  a, ViewFactory sample code for javax.swing.text.ViewFactory definition code for javax.swing.text.ViewFactory  f)
          Gives notification that something was removed from the document in a location that this view is responsible for.
 void setGlyphPainter sample code for javax.swing.text.GlyphView.setGlyphPainter(javax.swing.text.GlyphView.GlyphPainter) definition code for javax.swing.text.GlyphView.setGlyphPainter(javax.swing.text.GlyphView.GlyphPainter) (GlyphView.GlyphPainter sample code for javax.swing.text.GlyphView.GlyphPainter definition code for javax.swing.text.GlyphView.GlyphPainter  p)
          Sets the painter to use for rendering glyphs.
 int viewToModel sample code for javax.swing.text.GlyphView.viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[]) definition code for javax.swing.text.GlyphView.viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[]) (float x, float y, Shape sample code for java.awt.Shape definition code for java.awt.Shape  a, Position.Bias sample code for javax.swing.text.Position.Bias definition code for javax.swing.text.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.View sample code for javax.swing.text.View definition code for javax.swing.text.View
append sample code for javax.swing.text.View.append(javax.swing.text.View) definition code for javax.swing.text.View.append(javax.swing.text.View) , forwardUpdate sample code for javax.swing.text.View.forwardUpdate(javax.swing.event.DocumentEvent.ElementChange, javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) definition code for javax.swing.text.View.forwardUpdate(javax.swing.event.DocumentEvent.ElementChange, javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) , forwardUpdateToView sample code for javax.swing.text.View.forwardUpdateToView(javax.swing.text.View, javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) definition code for javax.swing.text.View.forwardUpdateToView(javax.swing.text.View, javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) , getAttributes sample code for javax.swing.text.View.getAttributes() definition code for javax.swing.text.View.getAttributes() , getChildAllocation sample code for javax.swing.text.View.getChildAllocation(int, java.awt.Shape) definition code for javax.swing.text.View.getChildAllocation(int, java.awt.Shape) , getContainer sample code for javax.swing.text.View.getContainer() definition code for javax.swing.text.View.getContainer() , getDocument sample code for javax.swing.text.View.getDocument() definition code for javax.swing.text.View.getDocument() , getElement sample code for javax.swing.text.View.getElement() definition code for javax.swing.text.View.getElement() , getGraphics sample code for javax.swing.text.View.getGraphics() definition code for javax.swing.text.View.getGraphics() , getMaximumSpan sample code for javax.swing.text.View.getMaximumSpan(int) definition code for javax.swing.text.View.getMaximumSpan(int) , getMinimumSpan sample code for javax.swing.text.View.getMinimumSpan(int) definition code for javax.swing.text.View.getMinimumSpan(int) , getParent sample code for javax.swing.text.View.getParent() definition code for javax.swing.text.View.getParent() , getResizeWeight sample code for javax.swing.text.View.getResizeWeight(int) definition code for javax.swing.text.View.getResizeWeight(int) , getToolTipText sample code for javax.swing.text.View.getToolTipText(float, float, java.awt.Shape) definition code for javax.swing.text.View.getToolTipText(float, float, java.awt.Shape) , getView sample code for javax.swing.text.View.getView(int) definition code for javax.swing.text.View.getView(int) , getViewCount sample code for javax.swing.text.View.getViewCount() definition code for javax.swing.text.View.getViewCount() , getViewFactory sample code for javax.swing.text.View.getViewFactory() definition code for javax.swing.text.View.getViewFactory() , getViewIndex sample code for javax.swing.text.View.getViewIndex(float, float, java.awt.Shape) definition code for javax.swing.text.View.getViewIndex(float, float, java.awt.Shape) , getViewIndex sample code for javax.swing.text.View.getViewIndex(int, javax.swing.text.Position.Bias) definition code for javax.swing.text.View.getViewIndex(int, javax.swing.text.Position.Bias) , insert sample code for javax.swing.text.View.insert(int, javax.swing.text.View) definition code for javax.swing.text.View.insert(int, javax.swing.text.View) , isVisible sample code for javax.swing.text.View.isVisible() definition code for javax.swing.text.View.isVisible() , modelToView sample code for javax.swing.text.View.modelToView(int, javax.swing.text.Position.Bias, int, javax.swing.text.Position.Bias, java.awt.Shape) definition code for javax.swing.text.View.modelToView(int, javax.swing.text.Position.Bias, int, javax.swing.text.Position.Bias, java.awt.Shape) , modelToView sample code for javax.swing.text.View.modelToView(int, java.awt.Shape) definition code for javax.swing.text.View.modelToView(int, java.awt.Shape) , preferenceChanged sample code for javax.swing.text.View.preferenceChanged(javax.swing.text.View, boolean, boolean) definition code for javax.swing.text.View.preferenceChanged(javax.swing.text.View, boolean, boolean) , remove sample code for javax.swing.text.View.remove(int) definition code for javax.swing.text.View.remove(int) , removeAll sample code for javax.swing.text.View.removeAll() definition code for javax.swing.text.View.removeAll() , replace sample code for javax.swing.text.View.replace(int, int, javax.swing.text.View[]) definition code for javax.swing.text.View.replace(int, int, javax.swing.text.View[]) , setParent sample code for javax.swing.text.View.setParent(javax.swing.text.View) definition code for javax.swing.text.View.setParent(javax.swing.text.View) , setSize sample code for javax.swing.text.View.setSize(float, float) definition code for javax.swing.text.View.setSize(float, float) , updateChildren sample code for javax.swing.text.View.updateChildren(javax.swing.event.DocumentEvent.ElementChange, javax.swing.event.DocumentEvent, javax.swing.text.ViewFactory) definition code for javax.swing.text.View.updateChildren(javax.swing.event.DocumentEvent.ElementChange, javax.swing.event.DocumentEvent, javax.swing.text.ViewFactory) , updateLayout sample code for javax.swing.text.View.updateLayout(javax.swing.event.DocumentEvent.ElementChange, javax.swing.event.DocumentEvent, java.awt.Shape) definition code for javax.swing.text.View.updateLayout(javax.swing.event.DocumentEvent.ElementChange, javax.swing.event.DocumentEvent, java.awt.Shape) , viewToModel sample code for javax.swing.text.View.viewToModel(float, float, java.awt.Shape) definition code for javax.swing.text.View.viewToModel(float, float, java.awt.Shape)
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Constructor Detail

GlyphView sample code for javax.swing.text.GlyphView(javax.swing.text.Element) definition code for javax.swing.text.GlyphView(javax.swing.text.Element)

public GlyphView(Element sample code for javax.swing.text.Element definition code for javax.swing.text.Element  elem)
Constructs a new view wrapped on an element.

Parameters:
elem - the element
Method Detail

clone sample code for javax.swing.text.GlyphView.clone() definition code for javax.swing.text.GlyphView.clone()

protected final Object sample code for java.lang.Object definition code for java.lang.Object  clone()
Creates a shallow copy. This is used by the createFragment and breakView methods.

Overrides:
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
the copy
See Also:
Cloneable sample code for java.lang.Cloneable definition code for java.lang.Cloneable

getGlyphPainter sample code for javax.swing.text.GlyphView.getGlyphPainter() definition code for javax.swing.text.GlyphView.getGlyphPainter()

public GlyphView.GlyphPainter sample code for javax.swing.text.GlyphView.GlyphPainter definition code for javax.swing.text.GlyphView.GlyphPainter  getGlyphPainter()
Fetch the currently installed glyph painter. If a painter has not yet been installed, and a default was not yet needed, null is returned.


setGlyphPainter sample code for javax.swing.text.GlyphView.setGlyphPainter(javax.swing.text.GlyphView.GlyphPainter) definition code for javax.swing.text.GlyphView.setGlyphPainter(javax.swing.text.GlyphView.GlyphPainter)

public void setGlyphPainter(GlyphView.GlyphPainter sample code for javax.swing.text.GlyphView.GlyphPainter definition code for javax.swing.text.GlyphView.GlyphPainter  p)
Sets the painter to use for rendering glyphs.


getText sample code for javax.swing.text.GlyphView.getText(int, int) definition code for javax.swing.text.GlyphView.getText(int, int)

public Segment sample code for javax.swing.text.Segment definition code for javax.swing.text.Segment  getText(int p0,
                       int p1)
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.

Parameters:
p0 - the starting document offset >= 0
p1 - the ending document offset >= p0
Returns:
the Segment containing the text

getBackground sample code for javax.swing.text.GlyphView.getBackground() definition code for javax.swing.text.GlyphView.getBackground()

public Color sample code for java.awt.Color definition code for java.awt.Color  getBackground()
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.


getForeground sample code for javax.swing.text.GlyphView.getForeground() definition code for javax.swing.text.GlyphView.getForeground()

public Color sample code for java.awt.Color definition code for java.awt.Color  getForeground()
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.


getFont sample code for javax.swing.text.GlyphView.getFont() definition code for javax.swing.text.GlyphView.getFont()

public Font sample code for java.awt.Font definition code for java.awt.Font  getFont()
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.


isUnderline sample code for javax.swing.text.GlyphView.isUnderline() definition code for javax.swing.text.GlyphView.isUnderline()

public boolean isUnderline()
Determine if the glyphs should be underlined. If true, an underline should be drawn through the baseline.


isStrikeThrough sample code for javax.swing.text.GlyphView.isStrikeThrough() definition code for javax.swing.text.GlyphView.isStrikeThrough()

public boolean isStrikeThrough()
Determine if the glyphs should have a strikethrough line. If true, a line should be drawn through the center of the glyphs.


isSubscript sample code for javax.swing.text.GlyphView.isSubscript() definition code for javax.swing.text.GlyphView.isSubscript()

public boolean isSubscript()
Determine if the glyphs should be rendered as superscript.


isSuperscript sample code for javax.swing.text.GlyphView.isSuperscript() definition code for javax.swing.text.GlyphView.isSuperscript()

public boolean isSuperscript()
Determine if the glyphs should be rendered as subscript.


getTabExpander sample code for javax.swing.text.GlyphView.getTabExpander() definition code for javax.swing.text.GlyphView.getTabExpander()

public TabExpander sample code for javax.swing.text.TabExpander definition code for javax.swing.text.TabExpander  getTabExpander()
Fetch the TabExpander to use if tabs are present in this view.


checkPainter sample code for javax.swing.text.GlyphView.checkPainter() definition code for javax.swing.text.GlyphView.checkPainter()

protected void checkPainter()
Check to see that a glyph painter exists. If a painter doesn't exist, a default glyph painter will be installed.


getTabbedSpan sample code for javax.swing.text.GlyphView.getTabbedSpan(float, javax.swing.text.TabExpander) definition code for javax.swing.text.GlyphView.getTabbedSpan(float, javax.swing.text.TabExpander)

public float getTabbedSpan(float x,
                           TabExpander sample code for javax.swing.text.TabExpander definition code for javax.swing.text.TabExpander  e)
Determines the desired span when using the given tab expansion implementation.

Specified by:
getTabbedSpan sample code for javax.swing.text.TabableView.getTabbedSpan(float, javax.swing.text.TabExpander) definition code for javax.swing.text.TabableView.getTabbedSpan(float, javax.swing.text.TabExpander) in interface TabableView sample code for javax.swing.text.TabableView definition code for javax.swing.text.TabableView
Parameters:
x - the position the view would be located at for the purpose of tab expansion >= 0.
e - how to expand the tabs when encountered.
Returns:
the desired span >= 0
See Also:
TabableView.getTabbedSpan(float, javax.swing.text.TabExpander) sample code for javax.swing.text.TabableView.getTabbedSpan(float, javax.swing.text.TabExpander) definition code for javax.swing.text.TabableView.getTabbedSpan(float, javax.swing.text.TabExpander)

getPartialSpan sample code for javax.swing.text.GlyphView.getPartialSpan(int, int) definition code for javax.swing.text.GlyphView.getPartialSpan(int, int)

public float getPartialSpan(int p0,
                            int p1)
Determines the span along the same axis as tab expansion for a portion of the view. This is intended for use by the TabExpander for cases where the tab expansion involves aligning the portion of text that doesn't have whitespace relative to the tab stop. There is therefore an assumption that the range given does not contain tabs.

This method can be called while servicing the getTabbedSpan or getPreferredSize. It has to arrange for its own text buffer to make the measurements.

Specified by:
getPartialSpan sample code for javax.swing.text.TabableView.getPartialSpan(int, int) definition code for javax.swing.text.TabableView.getPartialSpan(int, int) in interface TabableView sample code for javax.swing.text.TabableView definition code for javax.swing.text.TabableView
Parameters:
p0 - the starting document offset >= 0
p1 - the ending document offset >= p0
Returns:
the span >= 0

getStartOffset sample code for javax.swing.text.GlyphView.getStartOffset() definition code for javax.swing.text.GlyphView.getStartOffset()

public int getStartOffset()
Fetches the portion of the model that this view is responsible for.

Overrides:
getStartOffset sample code for javax.swing.text.View.getStartOffset() definition code for javax.swing.text.View.getStartOffset() in class View sample code for javax.swing.text.View definition code for javax.swing.text.View
Returns:
the starting offset into the model
See Also:
View.getStartOffset() sample code for javax.swing.text.View.getStartOffset() definition code for javax.swing.text.View.getStartOffset()

getEndOffset sample code for javax.swing.text.GlyphView.getEndOffset() definition code for javax.swing.text.GlyphView.getEndOffset()

public int getEndOffset()
Fetches the portion of the model that this view is responsible for.

Overrides:
getEndOffset sample code for javax.swing.text.View.getEndOffset() definition code for javax.swing.text.View.getEndOffset() in class View sample code for javax.swing.text.View definition code for javax.swing.text.View
Returns:
the ending offset into the model
See Also:
View.getEndOffset() sample code for javax.swing.text.View.getEndOffset() definition code for javax.swing.text.View.getEndOffset()

paint sample code for javax.swing.text.GlyphView.paint(java.awt.Graphics, java.awt.Shape) definition code for javax.swing.text.GlyphView.paint(java.awt.Graphics, java.awt.Shape)

public void paint(Graphics sample code for java.awt.Graphics definition code for java.awt.Graphics  g,
                  Shape sample code for java.awt.Shape definition code for java.awt.Shape  a)
Renders a portion of a text style run.

Specified by:
paint sample code for javax.swing.text.View.paint(java.awt.Graphics, java.awt.Shape) definition code for javax.swing.text.View.paint(java.awt.Graphics, java.awt.Shape) in class View sample code for javax.swing.text.View definition code for javax.swing.text.View
Parameters:
g - the rendering surface to use
a - the allocated region to render into
See Also:
View.paint(java.awt.Graphics, java.awt.Shape) sample code for javax.swing.text.View.paint(java.awt.Graphics, java.awt.Shape) definition code for javax.swing.text.View.paint(java.awt.Graphics, java.awt.Shape)

getPreferredSpan sample code for javax.swing.text.GlyphView.getPreferredSpan(int) definition code for javax.swing.text.GlyphView.getPreferredSpan(int)

public float getPreferredSpan(int axis)
Determines the preferred span for this view along an axis.

Specified by:
getPreferredSpan sample code for javax.swing.text.View.getPreferredSpan(int) definition code for javax.swing.text.View.getPreferredSpan(int) in class View sample code for javax.swing.text.View definition code for javax.swing.text.View
Parameters:
axis - may be either View.X_AXIS or View.Y_AXIS
Returns:
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.
See Also:
View.getPreferredSpan(int) sample code for javax.swing.text.View.getPreferredSpan(int) definition code for javax.swing.text.View.getPreferredSpan(int)

getAlignment sample code for javax.swing.text.GlyphView.getAlignment(int) definition code for javax.swing.text.GlyphView.getAlignment(int)

public float getAlignment(int axis)
Determines the desired alignment for this view along an axis. For the label, the alignment is along the font baseline for the y axis, and the superclasses alignment along the x axis.

Overrides:
getAlignment sample code for javax.swing.text.View.getAlignment(int) definition code for javax.swing.text.View.getAlignment(int) in class View sample code for javax.swing.text.View definition code for javax.swing.text.View
Parameters:
axis - may be either View.X_AXIS or View.Y_AXIS
Returns:
the desired alignment. This should be a value between 0.0 and 1.0 inclusive, where 0 indicates alignment at the origin and 1.0 indicates alignment to the full span away from the origin. An alignment of 0.5 would be the center of the view.

modelToView sample code for javax.swing.text.GlyphView.modelToView(int, java.awt.Shape, javax.swing.text.Position.Bias) definition code for javax.swing.text.GlyphView.modelToView(int, java.awt.Shape, javax.swing.text.Position.Bias)

public Shape sample code for java.awt.Shape definition code for java.awt.Shape  modelToView(int pos,
                         Shape sample code for java.awt.Shape definition code for java.awt.Shape  a,
                         Position.Bias sample code for javax.swing.text.Position.Bias definition code for javax.swing.text.Position.Bias  b)
                  throws BadLocationException sample code for javax.swing.text.BadLocationException definition code for javax.swing.text.BadLocationException 
Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it.

Specified by:
modelToView sample code for javax.swing.text.View.modelToView(int, java.awt.Shape, javax.swing.text.Position.Bias) definition code for javax.swing.text.View.modelToView(int, java.awt.Shape, javax.swing.text.Position.Bias) in class View sample code for javax.swing.text.View definition code for javax.swing.text.View
Parameters:
pos - the position to convert >= 0
a - the allocated region to render into
b - either Position.Bias.Forward or Position.Bias.Backward
Returns:
the bounding box of the given position
Throws:
BadLocationException sample code for javax.swing.text.BadLocationException definition code for javax.swing.text.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) sample code for javax.swing.text.View.modelToView(int, java.awt.Shape, javax.swing.text.Position.Bias) definition code for javax.swing.text.View.modelToView(int, java.awt.Shape, javax.swing.text.Position.Bias)

viewToModel sample code for javax.swing.text.GlyphView.viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[]) definition code for javax.swing.text.GlyphView.viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[])

public int viewToModel(float x,
                       float y,
                       Shape sample code for java.awt.Shape definition code for java.awt.Shape  a,
                       Position.Bias sample code for javax.swing.text.Position.Bias definition code for javax.swing.text.Position.Bias [] biasReturn)
Provides a mapping from the view coordinate space to the logical coordinate space of the model.

Specified by:
viewToModel sample code for javax.swing.text.View.viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[]) definition code for javax.swing.text.View.viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[]) in class View sample code for javax.swing.text.View definition code for javax.swing.text.View
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
Returns:
the location within the model that best represents the given point of view >= 0
See Also:
View.viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[]) sample code for javax.swing.text.View.viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[]) definition code for javax.swing.text.View.viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[])

getBreakWeight sample code for javax.swing.text.GlyphView.getBreakWeight(int, float, float) definition code for javax.swing.text.GlyphView.getBreakWeight(int, float, float)

public int getBreakWeight(int axis,
                          float pos,
                          float len)
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.

Overrides:
getBreakWeight sample code for javax.swing.text.View.getBreakWeight(int, float, float) definition code for javax.swing.text.View.getBreakWeight(int, float, float) in class View sample code for javax.swing.text.View definition code for javax.swing.text.View
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.
Returns:
the weight, which should be a value between View.ForcedBreakWeight and View.BadBreakWeight.
See Also:
LabelView sample code for javax.swing.text.LabelView definition code for javax.swing.text.LabelView , ParagraphView sample code for javax.swing.text.ParagraphView definition code for javax.swing.text.ParagraphView , View.BadBreakWeight sample code for javax.swing.text.View.BadBreakWeight definition code for javax.swing.text.View.BadBreakWeight , View.GoodBreakWeight sample code for javax.swing.text.View.GoodBreakWeight definition code for javax.swing.text.View.GoodBreakWeight , View.ExcellentBreakWeight sample code for javax.swing.text.View.ExcellentBreakWeight definition code for javax.swing.text.View.ExcellentBreakWeight , View.ForcedBreakWeight sample code for javax.swing.text.View.ForcedBreakWeight definition code for javax.swing.text.View.ForcedBreakWeight

breakView sample code for javax.swing.text.GlyphView.breakView(int, int, float, float) definition code for javax.swing.text.GlyphView.breakView(int, int, float, float)

public View sample code for javax.swing.text.View definition code for javax.swing.text.View  breakView(int axis,
                      int p0,
                      float pos,
                      float len)
Breaks this view on the given axis at the given length. This is implemented to attempt to break on a whitespace location, and returns a fragment with the whitespace at the end. If a whitespace location can't be found, the nearest character is used.

Overrides:
breakView sample code for javax.swing.text.View.breakView(int, int, float, float) definition code for javax.swing.text.View.breakView(int, int, float, float) in class View sample code for javax.swing.text.View definition code for javax.swing.text.View
Parameters:
axis - may be either View.X_AXIS or View.Y_AXIS
p0 - the location in the model where the fragment should start it's representation >= 0.
pos - the position along the axis that the broken view would occupy >= 0. This may be useful for things like tab calculations.
len - specifies the distance along the axis where a potential break is desired >= 0.
Returns:
the fragment of the view that represents the given span, if the view can be broken. If the view doesn't support breaking behavior, the view itself is returned.
See Also:
View.breakView(int, int, float, float) sample code for javax.swing.text.View.breakView(int, int, float, float) definition code for javax.swing.text.View.breakView(int, int, float, float)

createFragment sample code for javax.swing.text.GlyphView.createFragment(int, int) definition code for javax.swing.text.GlyphView.createFragment(int, int)

public View sample code for javax.swing.text.View definition code for javax.swing.text.View  createFragment(int p0,
                           int p1)
Creates a view that represents a portion of the element. This is potentially useful during formatting operations for taking measurements of fragments of the view. If the view doesn't support fragmenting (the default), it should return itself.

This view does support fragmenting. It is implemented to return a nested class that shares state in this view representing only a portion of the view.

Overrides:
createFragment sample code for javax.swing.text.View.createFragment(int, int) definition code for javax.swing.text.View.createFragment(int, int) in class View sample code for javax.swing.text.View definition code for javax.swing.text.View
Parameters:
p0 - the starting offset >= 0. This should be a value greater or equal to the element starting offset and less than the element ending offset.
p1 - the ending offset > p0. This should be a value less than or equal to the elements end offset and greater than the elements starting offset.
Returns:
the view fragment, or itself if the view doesn't support breaking into fragments
See Also:
LabelView sample code for javax.swing.text.LabelView definition code for javax.swing.text.LabelView

getNextVisualPositionFrom sample code for javax.swing.text.GlyphView.getNextVisualPositionFrom(int, javax.swing.text.Position.Bias, java.awt.Shape, int, javax.swing.text.Position.Bias[]) definition code for javax.swing.text.GlyphView.getNextVisualPositionFrom(int, javax.swing.text.Position.Bias, java.awt.Shape, int, javax.swing.text.Position.Bias[])

public int getNextVisualPositionFrom(int pos,
                                     Position.Bias sample code for javax.swing.text.Position.Bias definition code for javax.swing.text.Position.Bias  b,
                                     Shape sample code for java.awt.Shape definition code for java.awt.Shape  a,
                                     int direction,
                                     Position.Bias sample code for javax.swing.text.Position.Bias definition code for javax.swing.text.Position.Bias [] biasRet)
                              throws BadLocationException sample code for javax.swing.text.BadLocationException definition code for javax.swing.text.BadLocationException 
Provides a way to determine the next visually represented model location that one might place a caret. Some views may not be visible, they might not be in the same order found in the model, or they just might not allow access to some of the locations in the model.

Overrides:
getNextVisualPositionFrom sample code for javax.swing.text.View.getNextVisualPositionFrom(int, javax.swing.text.Position.Bias, java.awt.Shape, int, javax.swing.text.Position.Bias[]) definition code for javax.swing.text.View.getNextVisualPositionFrom(int, javax.swing.text.Position.Bias, java.awt.Shape, int, javax.swing.text.Position.Bias[]) in class View sample code for javax.swing.text.View definition code for javax.swing.text.View
Parameters:
pos - the position to convert >= 0
a - the allocated region to render into
direction - the direction from the current position that can be thought of as the arrow keys typically found on a keyboard. This may be SwingConstants.WEST, SwingConstants.EAST, SwingConstants.NORTH, or SwingConstants.SOUTH.
Returns:
the location within the model that best represents the next location visual position.
Throws:
BadLocationException sample code for javax.swing.text.BadLocationException definition code for javax.swing.text.BadLocationException
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - for an invalid direction

insertUpdate sample code for javax.swing.text.GlyphView.insertUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) definition code for javax.swing.text.GlyphView.insertUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory)

public void insertUpdate(DocumentEvent sample code for javax.swing.event.DocumentEvent definition code for javax.swing.event.DocumentEvent  e,
                         Shape sample code for java.awt.Shape definition code for java.awt.Shape  a,
                         ViewFactory sample code for javax.swing.text.ViewFactory definition code for javax.swing.text.ViewFactory  f)
Gives notification that something was inserted into the document in a location that this view is responsible for. This is implemented to call preferenceChanged along the axis the glyphs are rendered.

Overrides:
insertUpdate sample code for javax.swing.text.View.insertUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) definition code for javax.swing.text.View.insertUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) in class View sample code for javax.swing.text.View definition code for javax.swing.text.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.insertUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) sample code for javax.swing.text.View.insertUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) definition code for javax.swing.text.View.insertUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory)

removeUpdate sample code for javax.swing.text.GlyphView.removeUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) definition code for javax.swing.text.GlyphView.removeUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory)

public void removeUpdate(DocumentEvent sample code for javax.swing.event.DocumentEvent definition code for javax.swing.event.DocumentEvent  e,
                         Shape sample code for java.awt.Shape definition code for java.awt.Shape  a,
                         ViewFactory sample code for javax.swing.text.ViewFactory definition code for javax.swing.text.ViewFactory  f)
Gives notification that something was removed from the document in a location that this view is responsible for. This is implemented to call preferenceChanged along the axis the glyphs are rendered.

Overrides:
removeUpdate sample code for javax.swing.text.View.removeUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) definition code for javax.swing.text.View.removeUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) in class View sample code for javax.swing.text.View definition code for javax.swing.text.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.removeUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) sample code for javax.swing.text.View.removeUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) definition code for javax.swing.text.View.removeUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory)

changedUpdate sample code for javax.swing.text.GlyphView.changedUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) definition code for javax.swing.text.GlyphView.changedUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory)

public void changedUpdate(DocumentEvent sample code for javax.swing.event.DocumentEvent definition code for javax.swing.event.DocumentEvent  e,
                          Shape sample code for java.awt.Shape definition code for java.awt.Shape  a,
                          ViewFactory sample code for javax.swing.text.ViewFactory definition code for javax.swing.text.ViewFactory  f)
Gives notification from the document that attributes were changed in a location that this view is responsible for. This is implemented to call preferenceChanged along both the horizontal and vertical axis.

Overrides:
changedUpdate sample code for javax.swing.text.View.changedUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) definition code for javax.swing.text.View.changedUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) in class View sample code for javax.swing.text.View definition code for javax.swing.text.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(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) sample code for javax.swing.text.View.changedUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory) definition code for javax.swing.text.View.changedUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory)