javax.swing.text
Class IconView

java.lang.Object
  |
  +--javax.swing.text.View
        |
        +--javax.swing.text.IconView

public class IconView

extends View

Icon decorator that implements the view interface. The entire element is used to represent the icon. This acts as a gateway from the display-only View implementations to interactive lightweight icons (that is, it allows icons to be embedded into the View hierarchy. The parent of the icon is the container that is handed out by the associated view factory.

Fields inherited from class javax.swing.text.View

BadBreakWeight, ExcellentBreakWeight, ForcedBreakWeight, GoodBreakWeight, X_AXIS, Y_AXIS

Constructor Summary

IconView(Element elem)
Creates a new icon view that represents an element.

Method Summary

float	getAlignment(int axis) Determines the desired alignment for this view along an axis.
float	getPreferredSpan(int axis) Determines the preferred span for this view along an axis.
Shape	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	paint(Graphics g, Shape a) Paints the icon.
void	setSize(float width, float height) Sets the size of the view.
int	viewToModel(float x, float y, Shape a, Position.Bias[] bias) Provides a mapping from the view coordinate space to the logical coordinate space of the model.

Methods inherited from class javax.swing.text.View

breakView, changedUpdate, createFragment, getAttributes, getBreakWeight, getChildAllocation, getContainer, getDocument, getElement, getEndOffset, getMaximumSpan, getMinimumSpan, getNextVisualPositionFrom, getParent, getResizeWeight, getStartOffset, getView, getViewCount, getViewFactory, insertUpdate, isVisible, modelToView, modelToView, preferenceChanged, removeUpdate, setParent, viewToModel

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IconView

public IconView(Element elem)

Creates a new icon view that represents an element.

Parameters:

elem - the element to create a view for

Method Detail

paint

public void paint(Graphics g,
                  Shape a)

Paints the icon. The real paint behavior occurs naturally from the association that the icon has with its parent container (the same container hosting this view), so this simply allows us to position the icon properly relative to the view. Since the coordinate system for the view is simply the parent containers, positioning the child icon is easy.

Parameters:

g - the rendering surface to use

a - the allocated region to render into

Overrides:

paint in class View

See Also:

View.paint(java.awt.Graphics, java.awt.Shape)

getPreferredSpan

public float getPreferredSpan(int axis)

Determines the preferred span for this view along an axis.

Parameters:

axis - may be either View.X_AXIS or View.Y_AXIS

Throws:

IllegalArgumentException - for an invalid axis

Overrides:

getPreferredSpan in class View

getAlignment

public float getAlignment(int axis)

Determines the desired alignment for this view along an axis. This is implemented to give the alignment to the bottom of the icon along the y axis, and the default along the x axis.

Parameters:

axis - may be either View.X_AXIS or View.Y_AXIS

Overrides:

getAlignment in class View

modelToView

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

Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it.

Parameters:

pos - the position to convert >= 0

a - the allocated region to render into

Returns:

the bounding box of the given position

Throws:

BadLocationException - if the given position does not represent a valid location in the associated document

Overrides:

modelToView in class View

See Also:

View.modelToView(int, java.awt.Shape, javax.swing.text.Position.Bias)

viewToModel

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

Provides a mapping from the view coordinate space to the logical coordinate space of the model.

Parameters:

x - the X coordinate >= 0

y - the Y coordinate >= 0

a - the allocated region to render into

Returns:

the location within the model that best represents the given point of view >= 0

Overrides:

viewToModel in class View

See Also:

View.viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[])

setSize

public void setSize(float width,
                    float height)

Sets the size of the view. Since Icon doesn't support this functionality, there is nothing we can do.

Parameters:

width - the width

height - the height

Overrides:

setSize in class View