Home » openjdk-7 » javax » swing » text » [javadoc | source]
javax.swing.text
public class: GlyphView [javadoc | source]
java.lang.Object
   javax.swing.text.View
      javax.swing.text.GlyphView

All Implemented Interfaces:
    Cloneable, TabableView, SwingConstants

Direct Known Subclasses:
    InlineView, LabelView, ImageLabelView, BRView

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.

Nested Class Summary:
static class  GlyphView.JustificationInfo  Class to hold data needed to justify this GlyphView in a PargraphView.Row 
abstract public static class  GlyphView.GlyphPainter  A class to perform rendering of the glyphs. This can be implemented to be stateless, or to hold some information as a cache to facilitate faster rendering and model/view translation. At a minimum, the GlyphPainter allows a View implementation to perform its duties independant of a particular version of JVM and selection of capabilities (i.e. shaping for i18n, etc). 
Field Summary
 int offset     
 int length     
 boolean impliedCR     
 boolean skipWidth     
 TabExpander expander    how to expand tabs 
 int x    location for determining tab expansion against. 
 GlyphPainter painter    Glyph rendering functionality. 
static  GlyphPainter defaultPainter    The prototype painter used by default. 
Fields inherited from javax.swing.text.View:
BadBreakWeight,  GoodBreakWeight,  ExcellentBreakWeight,  ForcedBreakWeight,  X_AXIS,  Y_AXIS,  sharedBiasReturn
Constructor:
 public GlyphView(Element elem) 
    Constructs a new view wrapped on an element.
    Parameters:
    elem - the element
Method from javax.swing.text.GlyphView Summary:
breakView,   changedUpdate,   checkPainter,   clone,   createFragment,   getAlignment,   getBackground,   getBreakWeight,   getEndOffset,   getFont,   getForeground,   getGlyphPainter,   getJustificationInfo,   getMinimumSpan,   getNextVisualPositionFrom,   getPartialSpan,   getPreferredSpan,   getStartOffset,   getTabExpander,   getTabbedSpan,   getText,   insertUpdate,   isStrikeThrough,   isSubscript,   isSuperscript,   isUnderline,   modelToView,   paint,   paintTextUsingColor,   removeUpdate,   setGlyphPainter,   viewToModel
Methods from javax.swing.text.View:
append,   breakView,   changedUpdate,   createFragment,   forwardUpdate,   forwardUpdateToView,   getAlignment,   getAttributes,   getBreakWeight,   getChildAllocation,   getContainer,   getDocument,   getElement,   getEndOffset,   getGraphics,   getMaximumSpan,   getMinimumSpan,   getNextVisualPositionFrom,   getParent,   getPreferredSpan,   getResizeWeight,   getStartOffset,   getToolTipText,   getView,   getViewCount,   getViewFactory,   getViewIndex,   getViewIndex,   insert,   insertUpdate,   isVisible,   modelToView,   modelToView,   modelToView,   paint,   preferenceChanged,   remove,   removeAll,   removeUpdate,   replace,   setParent,   setSize,   updateChildren,   updateLayout,   viewToModel,   viewToModel
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.swing.text.GlyphView Detail:
 public 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.
 public  void changedUpdate(DocumentEvent e,
    Shape a,
    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.
 protected  void checkPainter() 
    Check to see that a glyph painter exists. If a painter doesn't exist, a default glyph painter will be installed.
 protected final Object clone() 
    Creates a shallow copy. This is used by the createFragment and breakView methods.
 public 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.

 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.
 public 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.
 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.
 public int getEndOffset() 
    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. 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. 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. If a painter has not yet been installed, and a default was not yet needed, null is returned.
 JustificationInfo getJustificationInfo(int rowStartOffset) 
 public float getMinimumSpan(int axis) 
    Determines the minimum span for this view along an axis.

    This implementation returns the longest non-breakable area within the view as a minimum span for {@code View.X_AXIS}.

 public int getNextVisualPositionFrom(int pos,
    Bias b,
    Shape a,
    int direction,
    Bias[] biasRet) throws 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.
 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.

 public float getPreferredSpan(int axis) 
    Determines the preferred span for this view along an axis.
 public int getStartOffset() 
    Fetches the portion of the model that this view is responsible for.
 public TabExpander getTabExpander() 
    Fetch the TabExpander to use if tabs are present in this view.
 public float getTabbedSpan(float x,
    TabExpander e) 
    Determines the desired span when using the given tab expansion implementation.
 public 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.
 public  void insertUpdate(DocumentEvent e,
    Shape a,
    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.
 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.
 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. If true, an underline should be drawn through the baseline.
 public Shape modelToView(int pos,
    Shape a,
    Bias b) throws BadLocationException 
    Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it.
 public  void paint(Graphics g,
    Shape a) 
    Renders a portion of a text style run.
 final  void paintTextUsingColor(Graphics g,
    Shape a,
    Color c,
    int p0,
    int p1) 
    Paints the specified region of text in the specified color.
 public  void removeUpdate(DocumentEvent e,
    Shape a,
    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.
 public  void setGlyphPainter(GlyphPainter p) 
    Sets the painter to use for rendering glyphs.
 public int viewToModel(float x,
    float y,
    Shape a,
    Bias[] biasReturn) 
    Provides a mapping from the view coordinate space to the logical coordinate space of the model.