Class InlineView
java.lang.Object
javax.swing.text.View
javax.swing.text.GlyphView
javax.swing.text.LabelView
javax.swing.text.html.InlineView
- All Implemented Interfaces:
Cloneable, SwingConstants, TabableView
Displays the inline element styles
based upon css attributes.
-
Nested Class Summary
Nested classes/interfaces declared in class GlyphView
GlyphView.GlyphPainterModifier and TypeClassDescriptionstatic classA class to perform rendering of the glyphs. -
Field Summary
Fields declared in class View
BadBreakWeight, ExcellentBreakWeight, ForcedBreakWeight, GoodBreakWeight, X_AXIS, Y_AXISModifier and TypeFieldDescriptionstatic final intThe weight to indicate a view is a bad break opportunity for the purpose of formatting.static final intThe weight to indicate a view supports breaking, and this represents a very attractive place to break.static final intThe 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 intThe weight to indicate a view supports breaking, but better opportunities probably exist.static final intAxis for format/break operations.static final intAxis 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, WESTModifier and TypeFieldDescriptionstatic final intBox-orientation constant used to specify the bottom of a box.static final intThe central position in an area.static final intCompass-direction east (right).static final intHorizontal orientation.static final intIdentifies the leading edge of text for use with left-to-right and right-to-left languages.static final intBox-orientation constant used to specify the left side of a box.static final intIdentifies the next direction in a sequence.static final intCompass-direction North (up).static final intCompass-direction north-east (upper right).static final intCompass-direction north west (upper left).static final intIdentifies the previous direction in a sequence.static final intBox-orientation constant used to specify the right side of a box.static final intCompass-direction south (down).static final intCompass-direction south-east (lower right).static final intCompass-direction south-west (lower left).static final intBox-orientation constant used to specify the top of a box.static final intIdentifies the trailing edge of text for use with left-to-right and right-to-left languages.static final intVertical orientation.static final intCompass-direction west (left). -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbreakView(int axis, int offset, float pos, float len) Tries to break this view on the given axis.voidchangedUpdate(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 attributes to use when rendering.intgetBreakWeight(int axis, float pos, float len) Determines how attractive a break opportunity in this view is.protected StyleSheetConvenient method to get the StyleSheet.voidinsertUpdate(DocumentEvent e, Shape a, ViewFactory f) Gives notification that something was inserted into the document in a location that this view is responsible for.voidremoveUpdate(DocumentEvent e, Shape a, ViewFactory f) Gives notification that something was removed from the document in a location that this view is responsible for.protected voidSet the cached properties from the attributes.Methods declared in class LabelView
getBackground, getFont, getFontMetrics, getForeground, isStrikeThrough, isSubscript, isSuperscript, isUnderline, setBackground, setStrikeThrough, setSubscript, setSuperscript, setUnderlineModifier and TypeMethodDescriptionFetches the background color to use to render the glyphs.getFont()Fetches the font that the glyphs should be based upon.protected FontMetricsDeprecated.FontMetrics are not used for glyph rendering when running in the JDK.Fetches the foreground color to use to render the glyphs.booleanDetermines if the glyphs should have a strikethrough line.booleanDetermines if the glyphs should be rendered as superscript.booleanDetermines if the glyphs should be rendered as subscript.booleanDetermines if the glyphs should be underlined.protected voidsetBackground(Color bg) Sets the background color for the view.protected voidsetStrikeThrough(boolean s) Sets whether or not the view has a strike/line through it.protected voidsetSubscript(boolean s) Sets whether or not the view represents a subscript.protected voidsetSuperscript(boolean s) Sets whether or not the view represents a superscript.protected voidsetUnderline(boolean u) Sets whether or not the view is underlined.Methods declared in class GlyphView
checkPainter, clone, createFragment, getAlignment, getEndOffset, getGlyphPainter, getMinimumSpan, getNextVisualPositionFrom, getPartialSpan, getPreferredSpan, getStartOffset, getTabbedSpan, getTabExpander, getText, modelToView, paint, setGlyphPainter, viewToModelModifier and TypeMethodDescriptionprotected voidCheck to see that a glyph painter exists.protected final Objectclone()Creates a shallow copy.createFragment(int p0, int p1) Creates a view that represents a portion of the element.floatgetAlignment(int axis) Determines the desired alignment for this view along an axis.intFetches the portion of the model that this view is responsible for.Fetch the currently installed glyph painter.floatgetMinimumSpan(int axis) Determines the minimum span for this view along an axis.intgetNextVisualPositionFrom(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.floatgetPartialSpan(int p0, int p1) Determines the span along the same axis as tab expansion for a portion of the view.floatgetPreferredSpan(int axis) Determines the preferred span for this view along an axis.intFetches the portion of the model that this view is responsible for.floatgetTabbedSpan(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.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.voidRenders a portion of a text style run.voidSets the painter to use for rendering glyphs.intviewToModel(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, 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, viewToModelModifier and TypeMethodDescriptionvoidAppends a single child view.protected voidForwards the givenDocumentEventto the child views that need to be notified of the change to the model.protected voidforwardUpdateToView(View v, DocumentEvent e, Shape a, ViewFactory f) Forwards theDocumentEventto the give child view.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 aGraphicsfor rendering.floatgetMaximumSpan(int axis) Determines the maximum span for this view along an axis.Returns the parent of the view.intgetResizeWeight(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.intReturns the number of views in this view.Fetches theViewFactoryimplementation that is feeding the view hierarchy.intgetViewIndex(float x, float y, Shape allocation) Returns the child view index representing the given position in the view.intgetViewIndex(int pos, Position.Bias b) Returns the child view index representing the given position in the model.voidInserts a single child view.booleanReturns 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.voidpreferenceChanged(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.voidremove(int i) Removes one of the children at the given position.voidRemoves all of the children.voidReplaces child views.voidEstablishes the parent view for this view.voidsetSize(float width, float height) Sets the size of the view.protected booleanUpdates 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 voidUpdates the layout in response to receiving notification of change from the model.intviewToModel(float x, float y, Shape a) Deprecated.Methods declared in class Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitModifier and TypeMethodDescriptionbooleanIndicates whether some other object is "equal to" this one.protected voidfinalize()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.inthashCode()Returns a hash code value for this object.final voidnotify()Wakes up a single thread that is waiting on this object's monitor.final voidWakes up all threads that are waiting on this object's monitor.toString()Returns a string representation of the object.final voidwait()Causes the current thread to wait until it is awakened, typically by being notified or interrupted.final voidwait(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 voidwait(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
-
InlineView
Constructs a new view wrapped on an element.- Parameters:
elem- the element
-
-
Method Details
-
insertUpdate
Gives notification that something was inserted into the document in a location that this view is responsible for. If either parameter isnull, behavior of this method is implementation dependent.- Overrides:
insertUpdatein 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- Since:
- 1.5
- See Also:
-
removeUpdate
Gives notification that something was removed from the document in a location that this view is responsible for. If either parameter isnull, behavior of this method is implementation dependent.- Overrides:
removeUpdatein 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- Since:
- 1.5
- See Also:
-
changedUpdate
Gives notification from the document that attributes were changed in a location that this view is responsible for.- Overrides:
changedUpdatein classLabelView- 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:
-
getAttributes
Fetches the attributes to use when rendering. This is implemented to multiplex the attributes specified in the model with a StyleSheet.- Overrides:
getAttributesin classView- Returns:
- the attributes to use when rendering
-
getBreakWeight
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 callbreakViewon in the process of formatting. A view that represents text that has whitespace in it might be more attractive than a view that has no whitespace, for example. The higher the weight, the more attractive the break. A value equal to or lower thanBadBreakWeightshould not be considered for a break. A value greater than or equal toForcedBreakWeightshould be broken.This is implemented to provide the default behavior of returning
BadBreakWeightunless the length is greater than the length of the view in which case the entire view represents the fragment. Unless a view has been written to support breaking behavior, it is not attractive to try and break the view. An example of a view that does support breaking isLabelView. An example of a view that uses break weight isParagraphView.- Overrides:
getBreakWeightin classGlyphView- Parameters:
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.- Returns:
- the weight, which should be a value between ForcedBreakWeight and BadBreakWeight.
- See Also:
-
breakView
Tries to break this view on the given axis. Refer toView.breakView(int, int, float, float)for a complete description of this method.Behavior of this method is unspecified in case
axisis neitherView.X_AXISnorView.Y_AXIS, and in caseoffset,pos, orlenis null.- Overrides:
breakViewin classGlyphView- Parameters:
axis- may be eitherView.X_AXISorView.Y_AXISoffset- the location in the document model that a broken fragment would occupy >= 0. This would be the starting offset of the fragment returnedpos- the position along the axis that the broken view would occupy >= 0. This may be useful for things like tab calculationslen- specifies the distance along the axis where a potential break is desired >= 0- Returns:
- the fragment of the view that represents the given span.
- Since:
- 1.5
- See Also:
-
setPropertiesFromAttributes
protected void setPropertiesFromAttributes()Set the cached properties from the attributes.- Overrides:
setPropertiesFromAttributesin classLabelView
-
getStyleSheet
Convenient method to get the StyleSheet.- Returns:
- the StyleSheet
-