Cloneable
, SwingConstants
, TabableView
LabelView
public class GlyphView extends View implements TabableView, Cloneable
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.
Modifier and Type | Class | Description |
---|---|---|
static class |
GlyphView.GlyphPainter |
A class to perform rendering of the glyphs. |
BadBreakWeight, ExcellentBreakWeight, ForcedBreakWeight, GoodBreakWeight, X_AXIS, Y_AXIS
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST
Constructor | Description |
---|---|
GlyphView |
Constructs a new view wrapped on an element. |
Modifier and Type | Method | Description |
---|---|---|
View |
breakView |
Breaks this view on the given axis at the given length. |
void |
changedUpdate |
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. |
protected final Object |
clone() |
Creates a shallow copy. |
View |
createFragment |
Creates a view that represents a portion of the element. |
float |
getAlignment |
Determines the desired alignment for this view along an axis. |
Color |
getBackground() |
Fetch the background color to use to render the glyphs. |
int |
getBreakWeight |
Determines how attractive a break opportunity in this view is. |
int |
getEndOffset() |
Fetches the portion of the model that this view is responsible for. |
Font |
getFont() |
Fetch the font that the glyphs should be based upon. |
Color |
getForeground() |
Fetch the foreground color to use to render the glyphs. |
GlyphView.GlyphPainter |
getGlyphPainter() |
Fetch the currently installed glyph painter. |
float |
getMinimumSpan |
Determines the minimum span for this view along an axis. |
int |
getNextVisualPositionFrom |
Provides a way to determine the next visually represented model location that one might place a caret. |
float |
getPartialSpan |
Determines the span along the same axis as tab expansion for a portion of the view. |
float |
getPreferredSpan |
Determines the preferred span for this view along an axis. |
int |
getStartOffset() |
Fetches the portion of the model that this view is responsible for. |
float |
getTabbedSpan |
Determines the desired span when using the given tab expansion implementation. |
TabExpander |
getTabExpander() |
Fetch the TabExpander to use if tabs are present in this view. |
Segment |
getText |
Fetch a reference to the text that occupies the given range. |
void |
insertUpdate |
Gives notification that something was inserted into the document in a location that this view is responsible for. |
boolean |
isStrikeThrough() |
Determine if the glyphs should have a strikethrough line. |
boolean |
isSubscript() |
Determine if the glyphs should be rendered as superscript. |
boolean |
isSuperscript() |
Determine if the glyphs should be rendered as subscript. |
boolean |
isUnderline() |
Determine if the glyphs should be underlined. |
Shape |
modelToView |
Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it. |
void |
paint |
Renders a portion of a text style run. |
void |
removeUpdate |
Gives notification that something was removed from the document in a location that this view is responsible for. |
void |
setGlyphPainter |
Sets the painter to use for rendering glyphs. |
int |
viewToModel |
Provides a mapping from the view coordinate space to the logical coordinate space of the model. |
append, forwardUpdate, forwardUpdateToView, getAttributes, getChildAllocation, getContainer, getDocument, getElement, getGraphics, getMaximumSpan, getParent, getResizeWeight, getToolTipText, getView, getViewCount, getViewFactory, getViewIndex, getViewIndex, insert, isVisible, modelToView, modelToView, preferenceChanged, remove, removeAll, replace, setParent, setSize, updateChildren, updateLayout, viewToModel
public GlyphView(Element elem)
elem
- the elementprotected final Object clone()
public GlyphView.GlyphPainter getGlyphPainter()
public void setGlyphPainter(GlyphView.GlyphPainter p)
p
- the painter to use for rendering glyphspublic Segment getText(int p0, int p1)
p0
- the starting document offset >= 0p1
- the ending document offset >= p0Segment
containing the textpublic Color getBackground()
StyledDocument.getBackground
if the associated document is a styled document, otherwise it returns null.public Color getForeground()
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 Font getFont()
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 boolean isUnderline()
public boolean isStrikeThrough()
public boolean isSubscript()
public boolean isSuperscript()
public TabExpander getTabExpander()
protected void checkPainter()
public float getTabbedSpan(float x, TabExpander e)
getTabbedSpan
in interface TabableView
x
- the position the view would be located at for the purpose of tab expansion >= 0.e
- how to expand the tabs when encountered.public float getPartialSpan(int p0, int p1)
This method can be called while servicing the getTabbedSpan or getPreferredSize. It has to arrange for its own text buffer to make the measurements.
getPartialSpan
in interface TabableView
p0
- the starting document offset >= 0p1
- the ending document offset >= p0public int getStartOffset()
getStartOffset
in class View
public int getEndOffset()
getEndOffset
in class View
public void paint(Graphics g, Shape a)
public float getMinimumSpan(int axis)
This implementation returns the longest non-breakable area within the view as a minimum span for View.X_AXIS
.
getMinimumSpan
in class View
axis
- may be either View.X_AXIS
or View.Y_AXIS
IllegalArgumentException
- if the axis
parameter is invalidpublic float getPreferredSpan(int axis)
getPreferredSpan
in class View
axis
- may be either View.X_AXIS or View.Y_AXISpublic float getAlignment(int axis)
getAlignment
in class View
axis
- may be either View.X_AXIS or View.Y_AXISpublic Shape modelToView(int pos, Shape a, Position.Bias b) throws BadLocationException
modelToView
in class View
pos
- the position to convert >= 0a
- the allocated region to render intob
- either Position.Bias.Forward
or Position.Bias.Backward
BadLocationException
- if the given position does not represent a valid location in the associated documentpublic int viewToModel(float x, float y, Shape a, Position.Bias[] biasReturn)
viewToModel
in class View
x
- the X coordinate >= 0y
- the Y coordinate >= 0a
- the allocated region to render intobiasReturn
- either Position.Bias.Forward
or Position.Bias.Backward
is returned as the zero-th element of this arraypublic int getBreakWeight(int axis, float pos, float len)
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.
getBreakWeight
in class View
axis
- may be either View.X_AXIS or View.Y_AXISpos
- 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.public View breakView(int axis, int p0, float pos, float len)
breakView
in class View
axis
- may be either View.X_AXIS or View.Y_AXISp0
- 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.public View createFragment(int p0, int p1)
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.
createFragment
in class View
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.public int getNextVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet) throws BadLocationException
BadLocationException
will be thrown.getNextVisualPositionFrom
in class View
pos
- the position to convertb
- the biasa
- the allocated region to render intodirection
- 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.biasRet
- the returned biasBadLocationException
- the given position is not a valid position within the documentIllegalArgumentException
- for an invalid directionpublic void insertUpdate(DocumentEvent e, Shape a, ViewFactory f)
insertUpdate
in class View
e
- the change information from the associated documenta
- the current allocation of the viewf
- the factory to use to rebuild if the view has childrenpublic void removeUpdate(DocumentEvent e, Shape a, ViewFactory f)
removeUpdate
in class View
e
- the change information from the associated documenta
- the current allocation of the viewf
- the factory to use to rebuild if the view has childrenpublic void changedUpdate(DocumentEvent e, Shape a, ViewFactory f)
changedUpdate
in class View
e
- the change information from the associated documenta
- the current allocation of the viewf
- the factory to use to rebuild if the view has children
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/swing/text/GlyphView.html