Class LabelView
- All Implemented Interfaces:
Cloneable, SwingConstants, TabableView
- Direct Known Subclasses:
InlineView
LabelView
is a styled chunk of text
that represents a view mapped over an element in the
text model. It caches the character level attributes
used for rendering.-
Nested Class Summary
Nested classes/interfaces declared in class GlyphView
GlyphView.GlyphPainter
Modifier and TypeClassDescriptionstatic class
A class to perform rendering of the glyphs. -
Field Summary
Fields declared in class View
BadBreakWeight, ExcellentBreakWeight, ForcedBreakWeight, GoodBreakWeight, X_AXIS, Y_AXIS
Modifier and TypeFieldDescriptionstatic final int
The weight to indicate a view is a bad break opportunity for the purpose of formatting.static final int
The weight to indicate a view supports breaking, and this represents a very attractive place to break.static final int
The weight to indicate a view supports breaking, and must be broken to be represented properly when placed in a view that formats its children by breaking them.static final int
The weight to indicate a view supports breaking, but better opportunities probably exist.static final int
Axis for format/break operations.static final int
Axis for format/break operations.Fields declared in interface SwingConstants
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST
Modifier and TypeFieldDescriptionstatic final int
Box-orientation constant used to specify the bottom of a box.static final int
The central position in an area.static final int
Compass-direction east (right).static final int
Horizontal orientation.static final int
Identifies the leading edge of text for use with left-to-right and right-to-left languages.static final int
Box-orientation constant used to specify the left side of a box.static final int
Identifies the next direction in a sequence.static final int
Compass-direction North (up).static final int
Compass-direction north-east (upper right).static final int
Compass-direction north west (upper left).static final int
Identifies the previous direction in a sequence.static final int
Box-orientation constant used to specify the right side of a box.static final int
Compass-direction south (down).static final int
Compass-direction south-east (lower right).static final int
Compass-direction south-west (lower left).static final int
Box-orientation constant used to specify the top of a box.static final int
Identifies the trailing edge of text for use with left-to-right and right-to-left languages.static final int
Vertical orientation.static final int
Compass-direction west (left). -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
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.Fetches the background color to use to render the glyphs.getFont()
Fetches the font that the glyphs should be based upon.protected FontMetrics
Deprecated.FontMetrics are not used for glyph rendering when running in the JDK.Fetches the foreground color to use to render the glyphs.boolean
Determines if the glyphs should have a strikethrough line.boolean
Determines if the glyphs should be rendered as superscript.boolean
Determines if the glyphs should be rendered as subscript.boolean
Determines if the glyphs should be underlined.protected void
setBackground
(Color bg) Sets the background color for the view.protected void
Sets the cached properties from the attributes.protected void
setStrikeThrough
(boolean s) Sets whether or not the view has a strike/line through it.protected void
setSubscript
(boolean s) Sets whether or not the view represents a subscript.protected void
setSuperscript
(boolean s) Sets whether or not the view represents a superscript.protected void
setUnderline
(boolean u) Sets whether or not the view is underlined.Methods declared in class GlyphView
breakView, checkPainter, clone, createFragment, getAlignment, getBreakWeight, getEndOffset, getGlyphPainter, getMinimumSpan, getNextVisualPositionFrom, getPartialSpan, getPreferredSpan, getStartOffset, getTabbedSpan, getTabExpander, getText, insertUpdate, modelToView, paint, removeUpdate, setGlyphPainter, viewToModel
Modifier and TypeMethodDescriptionbreakView
(int axis, int p0, float pos, float len) Breaks this view on the given axis at the given length.protected void
Check to see that a glyph painter exists.protected final Object
clone()
Creates a shallow copy.createFragment
(int p0, int p1) Creates a view that represents a portion of the element.float
getAlignment
(int axis) Determines the desired alignment for this view along an axis.int
getBreakWeight
(int axis, float pos, float len) Determines how attractive a break opportunity in this view is.int
Fetches the portion of the model that this view is responsible for.Fetch the currently installed glyph painter.float
getMinimumSpan
(int axis) Determines the minimum span for this view along an axis.int
getNextVisualPositionFrom
(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet) Provides a way to determine the next visually represented model location that one might place a caret.float
getPartialSpan
(int p0, int p1) Determines the span along the same axis as tab expansion for a portion of the view.float
getPreferredSpan
(int axis) Determines the preferred span for this view along an axis.int
Fetches the portion of the model that this view is responsible for.float
getTabbedSpan
(float x, TabExpander e) Determines the desired span when using the given tab expansion implementation.Fetch the TabExpander to use if tabs are present in this view.getText
(int p0, int p1) Fetch a reference to the text that occupies the given range.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.modelToView
(int pos, Shape a, Position.Bias b) Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it.void
Renders a portion of a text style run.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.void
Sets the painter to use for rendering glyphs.int
viewToModel
(float x, float y, Shape a, Position.Bias[] biasReturn) Provides a mapping from the view coordinate space to the logical coordinate space of the model.Methods declared in class View
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
Modifier and TypeMethodDescriptionvoid
Appends a single child view.protected void
Forwards the givenDocumentEvent
to the child views that need to be notified of the change to the model.protected void
forwardUpdateToView
(View v, DocumentEvent e, Shape a, ViewFactory f) Forwards theDocumentEvent
to the give child view.Fetches the attributes to use when rendering.getChildAllocation
(int index, Shape a) Fetches the allocation for the given child view.Fetches the container hosting the view.Fetches the model associated with the view.Fetches the structural portion of the subject that this view is mapped to.Fetch aGraphics
for rendering.float
getMaximumSpan
(int axis) Determines the maximum span for this view along an axis.Returns the parent of the view.int
getResizeWeight
(int axis) Determines the resizability of the view along the given axis.getToolTipText
(float x, float y, Shape allocation) Returns the tooltip text at the specified location.getView
(int n) Gets the nth child view.int
Returns the number of views in this view.Fetches theViewFactory
implementation that is feeding the view hierarchy.int
getViewIndex
(float x, float y, Shape allocation) Returns the child view index representing the given position in the view.int
getViewIndex
(int pos, Position.Bias b) Returns the child view index representing the given position in the model.void
Inserts a single child view.boolean
Returns a boolean that indicates whether the view is visible or not.modelToView
(int pos, Shape a) Deprecated.modelToView
(int p0, Position.Bias b0, int p1, Position.Bias b1, Shape a) Provides a mapping, for a given region, from the document model coordinate space to the view coordinate space.void
preferenceChanged
(View child, boolean width, boolean height) Child views can call this on the parent to indicate that the preference has changed and should be reconsidered for layout.void
remove
(int i) Removes one of the children at the given position.void
Removes all of the children.void
Replaces child views.void
Establishes the parent view for this view.void
setSize
(float width, float height) Sets the size of the view.protected boolean
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.protected void
Updates the layout in response to receiving notification of change from the model.int
viewToModel
(float x, float y, Shape a) Deprecated.Methods declared in class Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Modifier and TypeMethodDescriptionboolean
Indicates whether some other object is "equal to" this one.protected void
finalize()
Deprecated, for removal: This API element is subject to removal in a future version.Finalization is deprecated and subject to removal in a future release.final Class
<?> getClass()
Returns the runtime class of thisObject
.int
hashCode()
Returns a hash code value for this object.final void
notify()
Wakes up a single thread that is waiting on this object's monitor.final void
Wakes up all threads that are waiting on this object's monitor.toString()
Returns a string representation of the object.final void
wait()
Causes the current thread to wait until it is awakened, typically by being notified or interrupted.final void
wait
(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.final void
wait
(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
-
Constructor Details
-
LabelView
Constructs a new view wrapped on an element.- Parameters:
elem
- the element
-
-
Method Details
-
setUnderline
protected void setUnderline(boolean u) Sets whether or not the view is underlined. Note that this setter is protected and is really only meant if you need to update some additional state when set.- Parameters:
u
- true if the view is underlined, otherwise false- See Also:
-
setStrikeThrough
protected void setStrikeThrough(boolean s) Sets whether or not the view has a strike/line through it. Note that this setter is protected and is really only meant if you need to update some additional state when set.- Parameters:
s
- true if the view has a strike/line through it, otherwise false- See Also:
-
setSuperscript
protected void setSuperscript(boolean s) Sets whether or not the view represents a superscript. Note that this setter is protected and is really only meant if you need to update some additional state when set.- Parameters:
s
- true if the view represents a superscript, otherwise false- See Also:
-
setSubscript
protected void setSubscript(boolean s) Sets whether or not the view represents a subscript. Note that this setter is protected and is really only meant if you need to update some additional state when set.- Parameters:
s
- true if the view represents a subscript, otherwise false- See Also:
-
setBackground
Sets the background color for the view. This method is typically invoked as part of configuring thisView
. If you need to customize the background color you should overridesetPropertiesFromAttributes
and invoke this method. A value of null indicates no background should be rendered, so that the background of the parentView
will show through.- Parameters:
bg
- background color, or null- Since:
- 1.5
- See Also:
-
setPropertiesFromAttributes
protected void setPropertiesFromAttributes()Sets the cached properties from the attributes. -
getFontMetrics
Deprecated.FontMetrics are not used for glyph rendering when running in the JDK.Fetches theFontMetrics
used for this view.- Returns:
- the
FontMetrics
used for this view
-
getBackground
Fetches the background color to use to render the glyphs. This is implemented to return a cached background color, which defaults tonull
.- Overrides:
getBackground
in classGlyphView
- Returns:
- the cached background color
- Since:
- 1.3
-
getForeground
Fetches the foreground color to use to render the glyphs. This is implemented to return a cached foreground color, which defaults tonull
.- Overrides:
getForeground
in classGlyphView
- Returns:
- the cached foreground color
- Since:
- 1.3
-
getFont
-
isUnderline
public boolean isUnderline()Determines if the glyphs should be underlined. If true, an underline should be drawn through the baseline. This is implemented to return the cached underline property.When you request this property,
LabelView
re-syncs its state with the properties of theElement
'sAttributeSet
. IfElement
'sAttributeSet
does not have this property set, it will revert to false.- Overrides:
isUnderline
in classGlyphView
- Returns:
- the value of the cached
underline
property - Since:
- 1.3
-
isStrikeThrough
public boolean isStrikeThrough()Determines if the glyphs should have a strikethrough line. If true, a line should be drawn through the center of the glyphs. This is implemented to return the cachedstrikeThrough
property.When you request this property,
LabelView
re-syncs its state with the properties of theElement
'sAttributeSet
. IfElement
'sAttributeSet
does not have this property set, it will revert to false.- Overrides:
isStrikeThrough
in classGlyphView
- Returns:
- the value of the cached
strikeThrough
property - Since:
- 1.3
-
isSubscript
public boolean isSubscript()Determines if the glyphs should be rendered as superscript.When you request this property,
LabelView
re-syncs its state with the properties of theElement
'sAttributeSet
. IfElement
'sAttributeSet
does not have this property set, it will revert to false.- Overrides:
isSubscript
in classGlyphView
- Returns:
- the value of the cached
subscript
property - Since:
- 1.3
-
isSuperscript
public boolean isSuperscript()Determines if the glyphs should be rendered as subscript.When you request this property,
LabelView
re-syncs its state with the properties of theElement
'sAttributeSet
. IfElement
'sAttributeSet
does not have this property set, it will revert to false.- Overrides:
isSuperscript
in classGlyphView
- Returns:
- the value of the cached
superscript
property - Since:
- 1.3
-
changedUpdate
Gives notification from the document that attributes were changed in a location that this view is responsible for.- Overrides:
changedUpdate
in classGlyphView
- Parameters:
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- See Also:
-