Contents | Package | Class | Tree | Deprecated | Index | Help Java 1.2 Beta 3
PREV | NEXT SHOW LISTS | HIDE LISTS

Class java.awt.swing.text.IconView

java.lang.Object
    |
    +----java.awt.swing.text.View
            |
            +----java.awt.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 java.awt.swing.text.View
 BadBreakWeight, ExcellentBreakWeight, ForcedBreakWeight, GoodBreakWeight, X_AXIS, Y_AXIS
 

Constructor Summary
 IconView(Element elem)
Creates a new 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)
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)
Provides a mapping from the view coordinate space to the logical coordinate space of the model.
 
Methods inherited from class java.awt.swing.text.View
 breakView, changedUpdate, createFragment, getAlignment, getBreakWeight, getChildAllocation, getContainer, getDocument, getElement, getEndOffset, getParent, getPreferredSpan, getResizeWeight, getStartOffset, getView, getViewCount, getViewFactory, insertUpdate, modelToView, paint, preferenceChanged, removeUpdate, setParent, setSize, 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 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:
paint

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
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 X_AXIS or Y_AXIS
Overrides:
getAlignment in class View

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

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

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

Contents | Package | Class | Tree | Deprecated | Index | Help Java 1.2 Beta 3
PREV | NEXT SHOW LISTS | HIDE LISTS

Submit a bug or feature
Submit comments/suggestions about new javadoc look.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.