public class

InlineView

extends LabelView
java.lang.Object
   ↳ javax.swing.text.View
     ↳ javax.swing.text.GlyphView
       ↳ javax.swing.text.LabelView
         ↳ javax.swing.text.html.InlineView

Class Overview

Displays the inline element styles based upon css attributes.

Summary

[Expand]
Inherited Constants
From class javax.swing.text.View
From interface javax.swing.SwingConstants
Public Constructors
InlineView(Element elem)
Constructs a new view wrapped on an element.
Public Methods
View breakView(int axis, int offset, float pos, float len)
Tries to break this view on the given axis.
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.
AttributeSet getAttributes()
Fetches the attributes to use when rendering.
int getBreakWeight(int axis, float pos, float len)
Determines how attractive a break opportunity in this view is.
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.
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.
Protected Methods
StyleSheet getStyleSheet()
void setPropertiesFromAttributes()
Set the cached properties from the attributes.
[Expand]
Inherited Methods
From class javax.swing.text.LabelView
From class javax.swing.text.GlyphView
From class javax.swing.text.View
From class java.lang.Object
From interface javax.swing.text.TabableView

Public Constructors

public InlineView (Element elem)

Constructs a new view wrapped on an element.

Parameters
elem the element

Public Methods

public View breakView (int axis, int offset, float pos, float len)

Tries to break this view on the given axis. Refer to breakView(int, int, float, float) for a complete description of this method.

Behavior of this method is unspecified in case axis is neither View.X_AXIS nor View.Y_AXIS, and in case offset, pos, or len is null.

Parameters
axis may be either View.X_AXIS or View.Y_AXIS
offset the location in the document model that a broken fragment would occupy >= 0. This would be the starting offset of the fragment returned
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.

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.

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

public AttributeSet getAttributes ()

Fetches the attributes to use when rendering. This is implemented to multiplex the attributes specified in the model with a StyleSheet.

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. 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 than BadBreakWeight should not be considered for a break. A value greater than or equal to ForcedBreakWeight should be broken.

This is implemented to provide the default behavior of returning BadBreakWeight unless 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 is LabelView. An example of a view that uses break weight is ParagraphView.

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 ForcedBreakWeight and BadBreakWeight.

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. If either parameter is null, behavior of this method is implementation dependent.

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

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. If either parameter is null, behavior of this method is implementation dependent.

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

Protected Methods

protected StyleSheet getStyleSheet ()

protected void setPropertiesFromAttributes ()

Set the cached properties from the attributes.