All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.sun.java.swing.text.BoxView 

java.lang.Object
   |
   +----com.sun.java.swing.text.View
           |
           +----com.sun.java.swing.text.CompositeView
                   |
                   +----com.sun.java.swing.text.BoxView
public class BoxView
extends CompositeView
A view of a text model that arranges its children into a box. It might be useful to represent something like a collection of lines, paragraphs, list items, chunks of text, etc.

Constructor Index

o BoxView(Element, int)
Constructs a BoxView.

Method Index

o changedUpdate(DocumentEvent, Shape, ViewFactory)
Gives notification from the document that attributes were changed in a location that this view is responsible for.
o childAllocation(int, Rectangle)
Allocates a region for a child view.
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 getResizeWeight(int)
Determines the resizability of the view along the given axis.
o getViewAtPoint(int, int, Rectangle)
Fetches the child view at the given point.
o insertUpdate(DocumentEvent, Shape, ViewFactory)
Gives notification that something was inserted into the document in a location that this view is responsible for.
o isAfter(int, int, Rectangle)
Determines if a point falls after an allocated region.
o isAllocationValid()
Are the allocations for the children still valid?
o isBefore(int, int, Rectangle)
Determines if a point falls before an allocated region.
o layout(int, int)
Performs layout of the children.
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)
Renders using the given rendering surface and area on that surface.
o paintChild(Graphics, Rectangle, int)
Paints a child.
o preferenceChanged(View, boolean, boolean)
Changes a preference for alignment.
o removeUpdate(DocumentEvent, Shape, ViewFactory)
Gives notification that something was removed from the document in a location that this view is responsible for.
o replace(int, int, View[])
Invalidates the layout and resizes the cache of requests/allocations.
o setSize(float, float)
Sets 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 BoxView 
 public BoxView(Element elem,
                int axis)
Constructs a BoxView.

Parameters:
elem - the element this view is responsible for

Methods

o paintChild 
 protected void paintChild(Graphics g,
                           Rectangle alloc,
                           int index)
Paints a child. By default that is all it does, but a subclass can use this to paint things relative to the child.

Parameters:
g - the graphics context
alloc - the allocated region to paint into
index - the child index
o replace 
 public void replace(int offset,
                     int length,
                     View elems[])
Invalidates the layout and resizes the cache of requests/allocations.

Parameters:
offset - the starting offset into the child views
length - the length
elems - the child views
Overrides:
replace in class CompositeView
o preferenceChanged 
 public void preferenceChanged(View child,
                               boolean width,
                               boolean height)
Changes a preference for alignment.

Parameters:
child - the child view
width - true if the width preference should change
height - true if the height preference should change
Overrides:
preferenceChanged in class View
o setSize 
 public void setSize(float width,
                     float height)
Sets the size of the view. If the size has changed, layout is redone. The size is the full size of the view including the inset areas.

Parameters:
width - the width
height - the height
Overrides:
setSize in class View
o paint 
 public void paint(Graphics g,
                   Shape allocation)
Renders using the given rendering surface and area on that surface.

Parameters:
g - the rendering surface to use
allocation - the allocated region to render into
Overrides:
paint in class View
See Also:
paint
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. This makes sure the allocation is valid before letting the superclass do it's thing.

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 CompositeView
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 - x coordinate of the view location to convert
y - y coordinate of the view location to convert
a - the allocated region to render into
Returns:
the location within the model that best represents the given point in the view
Overrides:
viewToModel in class CompositeView
See Also:
viewToModel
o getAlignment 
 public float getAlignment(int axis)
Determines the desired alignment for this view along an axis. This is implemented to give the total alignment needed to position the children with the alignment points lined up along the axis orthoginal to the axis that is being tiled. The axis being tiled will request to be centered (ie 0.5f).

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 getResizeWeight 
 public int getResizeWeight(int axis)
Determines the resizability of the view along the given axis. A value of 0 or less is not resizable.

Parameters:
axis - may be either X_AXIS or Y_AXIS
Overrides:
getResizeWeight in class View
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.
Throws: IllegalArgumentException
for an invalid axis type
Overrides:
getPreferredSpan in class View
o insertUpdate 
 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.

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
Overrides:
insertUpdate in class View
See Also:
insertUpdate
o removeUpdate 
 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.

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
Overrides:
removeUpdate in class View
See Also:
removeUpdate
o changedUpdate 
 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
Overrides:
changedUpdate in class View
See Also:
changedUpdate
o isAllocationValid 
 protected boolean isAllocationValid()
Are the allocations for the children still valid?

o isBefore 
 protected boolean isBefore(int x,
                            int y,
                            Rectangle innerAlloc)
Determines if a point falls before an allocated region.

Parameters:
x - the X coordinate
y - the Y coordinate
alloc - the allocated region. This is the area inside of the insets.
Returns:
true if the point lies before the region else false
Overrides:
isBefore in class CompositeView
o isAfter 
 protected boolean isAfter(int x,
                           int y,
                           Rectangle innerAlloc)
Determines if a point falls after an allocated region.

Parameters:
x - the X coordinate
y - the Y coordinate
alloc - the allocated region. This is the area inside of the insets.
Returns:
true if the point lies after the region else false
Overrides:
isAfter in class CompositeView
o getViewAtPoint 
 protected View getViewAtPoint(int x,
                               int y,
                               Rectangle alloc)
Fetches the child view at the given point.

Parameters:
x - the X coordinate
y - the Y coordinate
alloc - the parents inner allocation on entry, which should be changed to the childs allocation on exit.
Returns:
the view
Overrides:
getViewAtPoint in class CompositeView
o childAllocation 
 protected void childAllocation(int index,
                                Rectangle alloc)
Allocates a region for a child view.

Parameters:
index - the index of the child view to allocate
allocation - the allocated region
Overrides:
childAllocation in class CompositeView
o layout 
 protected void layout(int width,
                       int height)
Performs layout of the children. The size is the area inside of the insets.

Parameters:
width - the width
height - the height 
All Packages  Class Hierarchy  This Package  Previous  Next  Index