All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.sun.java.swing.text.CompositeView

java.lang.Object
   |
   +----com.sun.java.swing.text.View
           |
           +----com.sun.java.swing.text.CompositeView

public abstract class CompositeView

extends View

CompositeView(Element)

Constructs a JCompositeView for the given element.

append(View)

Convenience call to append a single child view

childAllocation(int, Rectangle)

Returns the allocation for a given child.

getBottomInset()

Gets the bottom inset.

getChildAllocation(int, Shape)

Fetch the allocation for the given child view.

getInsideAllocation(Shape)

Translates the allocation given to the view to the allocation used for composing the interior.

getLeftInset()

Gets the left inset.

getRightInset()

Gets the right inset.

getTopInset()

Gets the top inset.

getView(int)

Gets the nth view in this container.

getViewAtPoint(int, int, Rectangle)

Fetches the child view at the given point.

getViewAtPosition(int, Rectangle)

getViewCount()

Returns the number of views in this view.

insert(int, View)

Convenience call to replace to insert a single child

isAfter(int, int, Rectangle)

Tests whether a point is after the rectangle range.

isBefore(int, int, Rectangle)

Tests whether a point is before the rectangle range.

loadChildren(ViewFactory)

Loads all of the children to initialize the view.

modelToView(int, Shape)

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

removeAll()

Convenience call to replace to remove all of the children.

replace(int, int, View[])

Invalidates the layout and resizes the cache of requests/allocations.

setInsets(short, short, short, short)

Sets the insets for the view.

setParagraphInsets(AttributeSet)

Sets the insets from the paragraph attributes specified in the given attributes.

setParent(View)

Sets the parent of the view.

viewToModel(float, float, Shape)

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

 public CompositeView(Element elem)

Constructs a JCompositeView for the given element.

Parameters:

elem - the element this view is responsible for

 protected void loadChildren(ViewFactory f)

Loads all of the children to initialize the view. This is called by the setParent method. Subclasses can reimplement this to initialize their child views in a different manner. The default implementation creates a child view for each child element.

Parameters:

f - the view factory

 public void removeAll()

Convenience call to replace to remove all of the children.

 public void insert(int offs,
                    View v)

Convenience call to replace to insert a single child

 public void append(View v)

Convenience call to append a single child view

 public void replace(int offset,
                     int length,
                     View views[])

Invalidates the layout and resizes the cache of requests/allocations.

Parameters:

offset - the starting offset into the child views

length - the length

views - the child views

 public void setParent(View parent)

Sets the parent of the view. This is reimplemented to provide the superclass behavior as well as calling the loadChildren method. The children should not be loaded in the constructor because the act of setting the parent may cause them to try to search up the hierarchy (to get the hosting Container for example).

Parameters:

parent - the parent of the view

Overrides:

setParent in class View

 public int getViewCount()

Returns the number of views in this view.

Returns:

the number of views

Overrides:

getViewCount in class View

See Also:

getView

 public View getView(int n)

Gets the nth view in this container.

Parameters:

n - the number of the view to get

Returns:

the view

Overrides:

getView in class View

 public Shape getChildAllocation(int index,
                                 Shape a)

Fetch the allocation for the given child view. This enables finding out where various views are located, without assuming the views store their location.

Parameters:

index - the index of the child

a - the allocation to this view.

Returns:

the allocation to the child

Overrides:

getChildAllocation in class View

 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

 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 View

See Also:

viewToModel

 protected abstract boolean isBefore(int x,
                                     int y,
                                     Rectangle alloc)

Tests whether a point is before the rectangle range.

Parameters:

x - the X coordinate

y - the Y coordinate

alloc - the rectangle

Returns:

true if the point is before the specified range

 protected abstract boolean isAfter(int x,
                                    int y,
                                    Rectangle alloc)

Tests whether a point is after the rectangle range.

Parameters:

x - the X coordinate

y - the Y coordinate

alloc - the rectangle

Returns:

true if the point is after the specified range

 protected abstract 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 parent's allocation on entry, which should be changed to the child's allocation on exit

Returns:

the child view

 protected abstract void childAllocation(int index,
                                         Rectangle a)

Returns the allocation for a given child.

Parameters:

index - the index of the child

a - the allocation to the interior of the box on entry, and the allocation of the view containing the position on exit

Returns:

the allocation

 protected View getViewAtPosition(int pos,
                                  Rectangle a)

 protected Rectangle getInsideAllocation(Shape a)

Translates the allocation given to the view to the allocation used for composing the interior. This takes into account any margins that were specified.

Parameters:

a - The allocation given to the view.

Returns:

s The allocation that represents the inside of the view after the margins have all been removed.

 protected final void setParagraphInsets(AttributeSet attr)

Sets the insets from the paragraph attributes specified in the given attributes.

Parameters:

attr - the attributes

 protected final void setInsets(short top,
                                short left,
                                short bottom,
                                short right)

Sets the insets for the view.

Parameters:

top - the top inset

left - the left inset

bottom - the bottom inset

right - the right inset

 protected final short getLeftInset()

Gets the left inset.

Returns:

the inset

 protected final short getRightInset()

Gets the right inset.

Returns:

the inset

 protected final short getTopInset()

Gets the top inset.

Returns:

the inset

 protected final short getBottomInset()

Gets the bottom inset.

Returns:

the inset

All Packages  Class Hierarchy  This Package  Previous  Next  Index