javax.swing.text

Class IconView

public class IconView extends View

A View that can render an icon. This view is created by the {@link StyledEditorKit}'s view factory for all elements that have name {@link StyleConstants#IconElementName}. This is usually created by inserting an icon into JTextPane using {@link JTextPane#insertIcon(Icon)} The icon is determined using the attribute {@link StyleConstants#IconAttribute}, which's value must be an {@link Icon}.

Constructor Summary
	IconView(Element element) Creates a new `IconView` for the given `Element`.

Method Summary
float	getAlignment(int axis) Returns the alignment for this view.
float	getPreferredSpan(int axis) Returns the preferred span of the content managed by this `View` along the specified `axis`.
Shape	modelToView(int pos, Shape a, Position.Bias b) Maps a position in the document into the coordinate space of the View.
void	paint(Graphics g, Shape a) Renders the `Element` that is associated with this `View`.
int	viewToModel(float x, float y, Shape a, Position.Bias[] b) Maps coordinates from the `View`'s space into a position in the document model.

Constructor Detail

IconView

public IconView(Element element)

Creates a new IconView for the given Element.

Parameters: element the element that is rendered by this IconView

Method Detail

getAlignment

public float getAlignment(int axis)

Returns the alignment for this view. This will be 1.0 for the Y_AXIS, and the super behaviour for the X_AXIS.

Parameters: axis the axis for which to calculate the alignment

Returns: the alignment

getPreferredSpan

public float getPreferredSpan(int axis)

Returns the preferred span of the content managed by this View along the specified axis.

Parameters: axis the axis

Returns: the preferred span of this View.

modelToView

public Shape modelToView(int pos, Shape a, Position.Bias b)

Maps a position in the document into the coordinate space of the View. The output rectangle usually reflects the font height but has a width of zero.

Parameters: pos the position of the character in the model a the area that is occupied by the view b either {@link Position.Bias#Forward} or {@link Position.Bias#Backward} depending on the preferred direction bias. If null this defaults to Position.Bias.Forward

Returns: a rectangle that gives the location of the document position inside the view coordinate space

Throws: BadLocationException if pos is invalid IllegalArgumentException if b is not one of the above listed valid values

paint

public void paint(Graphics g, Shape a)

Renders the Element that is associated with this View.

Parameters: g the Graphics context to render to a the allocated region for the Element

viewToModel

public int viewToModel(float x, float y, Shape a, Position.Bias[] b)

Maps coordinates from the View's space into a position in the document model.

Parameters: x the x coordinate in the view space y the y coordinate in the view space a the allocation of this View b the bias to use

Returns: the position in the document that corresponds to the screen coordinates x, y