All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.sun.java.swing.text.IconView 

java.lang.Object
   |
   +----com.sun.java.swing.text.View
           |
           +----com.sun.java.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.

Constructor Index

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

Method Index

o getAlignment(int)
Determines the desired alignment for this view along an axis.
o getPreferredSpan(int)
Determines the preferred span for this view along an axis.
o modelToView(int, Shape)
Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it.
o paint(Graphics, Shape)
Paints the icon.
o setSize(float, float)
Set the size of the view.
o viewToModel(float, float, Shape)
Provides a mapping from the view coordinate space to the logical coordinate space of the model.

Constructors

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

Parameters:
elem - the element to create a view for

Methods

o 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:
paint
o getPreferredSpan 
 public float getPreferredSpan(int axis)
Determines the preferred span for this view along an axis.

Parameters:
axis - may be either X_AXIS or Y_AXIS
Returns:
s the span the view would like to be rendered into. Typically the view is told to render into the span that is returned, although there is no guarantee. The parent may choose to resize or break the view.
Overrides:
getPreferredSpan in class View
o 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 X_AXIS or Y_AXIS
Returns:
s the desired alignment. This should be a value between 0.0 and 1.0 where 0 indicates alignment at the origin and 1.0 indicates alignment to the full span away from the origin. An alignment of 0.5 would be the center of the view.
Overrides:
getAlignment in class View
o modelToView 
 public Shape modelToView(int pos,
                          Shape a) 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
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:
modelToView
o viewToModel 
 public int viewToModel(float x,
                        float y,
                        Shape a)
Provides a mapping from the view coordinate space to the logical coordinate space of the model.

Parameters:
x - the X coordinate
y - the Y coordinate
a - the allocated region to render into
Returns:
the location within the model that best represents the given point of view
Overrides:
viewToModel in class View
See Also:
viewToModel
o setSize 
 public void setSize(float width,
                     float height)
Set 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 
All Packages  Class Hierarchy  This Package  Previous  Next  Index