Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Java Platform 1.2
Beta 4

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

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

Direct Known Subclasses:

BoxView

public abstract class CompositeView

extends View

A view of a text model that has a children box. If the box is vertical, it might be useful to represent something like a collection of lines or paragraphs. If the box is horizontal, it might be used to represent unwrapped lines.

Fields inherited from class com.sun.java.swing.text.View

BadBreakWeight , ExcellentBreakWeight , ForcedBreakWeight , GoodBreakWeight , X_AXIS , Y_AXIS

Constructor Summary

CompositeView(Element elem)
Constructs a CompositeView for the given element.

Method Summary

void	append(View v) Appends a single child view.
protected abstract void	childAllocation(int index, Rectangle a) Returns the allocation for a given child.
protected short	getBottomInset() Gets the bottom inset.
Shape	getChildAllocation(int index, Shape a) Fetches the allocation for the given child view.
protected Rectangle	getInsideAllocation(Shape a) Translates the allocation given to the view to the allocation used for composing the interior.
protected short	getLeftInset() Gets the left inset.
protected short	getRightInset() Gets the right inset.
protected short	getTopInset() Gets the top inset.
View	getView(int n) Gets the n-th view in this container.
protected abstract View	getViewAtPoint(int x, int y, Rectangle alloc) Fetches the child view at the given point.
protected View	getViewAtPosition(int pos, Rectangle a) Fetches the child view that represents the given position in the model.
int	getViewCount() Returns the number of views in this view.
void	insert(int offs, View v) Inserts a single child view.
protected abstract boolean	isAfter(int x, int y, Rectangle alloc) Tests whether a point lies after the rectangle range.
protected abstract boolean	isBefore(int x, int y, Rectangle alloc) Tests whether a point lies before the rectangle range.
protected void	loadChildren(ViewFactory f) Loads all of the children to initialize the view.
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	removeAll() Removes all of the children.
void	replace(int offset, int length, View[] views) Invalidates the layout and resizes the cache of requests/allocations, allowing for the replacement of child views.
protected void	setInsets(short top, short left, short bottom, short right) Sets the insets for the view.
protected void	setParagraphInsets(AttributeSet attr) Sets the insets from the paragraph attributes specified in the given attributes.
void	setParent(View parent) Sets the parent 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 com.sun.java.swing.text.View

breakView , changedUpdate , createFragment , getAlignment , getAttributes , getBreakWeight , getContainer , getDocument , getElement , getEndOffset , getMaximumSpan , getMinimumSpan , getNextVisualPositionFrom , getParent , getPreferredSpan , getResizeWeight , getStartOffset , getViewFactory , insertUpdate , modelToView , paint , preferenceChanged , removeUpdate , setSize , viewToModel

Methods inherited from class java.lang.Object

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

Constructor Detail

CompositeView

public CompositeView(Element elem)

Constructs a CompositeView for the given element.

Parameters:

elem - the element this view is responsible for

Method Detail

loadChildren

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

removeAll

public void removeAll()

Removes all of the children.

insert

public void insert(int offs,
                   View v)

Inserts a single child view.

Parameters:

offs - the offset of the view to insert before >= 0

v - the view

append

public void append(View v)

Appends a single child view.

Parameters:

v - the view

replace

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

Invalidates the layout and resizes the cache of requests/allocations, allowing for the replacement of child views.

Parameters:

offset - the starting offset into the child views to insert before >= 0

length - the number of existing child views affected >= 0

views - the child views to use as replacements

setParent

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, null if none

Overrides:

setParent in class View

getViewCount

public int getViewCount()

Returns the number of views in this view.

Returns:

the number of views >= 0

Overrides:

getViewCount in class View

See Also:

getView(int)

getView

public View getView(int n)

Gets the n-th view in this container.

Parameters:

n - the number of the view to get, >= 0 && < getViewCount()

Returns:

the view

Overrides:

getView in class View

getChildAllocation

public Shape getChildAllocation(int index,
                                Shape a)

Fetches 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, >= 0 && < getViewCount()

a - the allocation to this view.

Returns:

the allocation to the child

Overrides:

getChildAllocation 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, com.sun.java.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 - x coordinate of the view location to convert >= 0

y - y coordinate of the view location to convert >= 0

a - the allocated region to render into

Returns:

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

Overrides:

viewToModel in class View

See Also:

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

isBefore

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

Tests whether a point lies before the rectangle range.

Parameters:

x - the X coordinate >= 0

y - the Y coordinate >= 0

alloc - the rectangle

Returns:

true if the point is before the specified range

isAfter

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

Tests whether a point lies after the rectangle range.

Parameters:

x - the X coordinate >= 0

y - the Y coordinate >= 0

alloc - the rectangle

Returns:

true if the point is after the specified range

getViewAtPoint

protected abstract View getViewAtPoint(int x,
                                       int y,
                                       Rectangle alloc)

Fetches the child view at the given point.

Parameters:

x - the X coordinate >= 0

y - the Y coordinate >= 0

alloc - the parent's allocation on entry, which should be changed to the child's allocation on exit

Returns:

the child view

childAllocation

protected abstract void childAllocation(int index,
                                        Rectangle a)

Returns the allocation for a given child.

Parameters:

index - the index of the child, >= 0 && < getViewCount()

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

getViewAtPosition

protected View getViewAtPosition(int pos,
                                 Rectangle a)

Fetches the child view that represents the given position in the model. This is implemented to fetch the view in the case where there is a child view for each child element.

Parameters:

pos - the position >= 0

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

getInsideAllocation

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.

setParagraphInsets

protected final void setParagraphInsets(AttributeSet attr)

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

Parameters:

attr - the attributes

setInsets

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

Sets the insets for the view.

Parameters:

top - the top inset >= 0

left - the left inset >= 0

bottom - the bottom inset >= 0

right - the right inset >= 0

getLeftInset

protected final short getLeftInset()

Gets the left inset.

Returns:

the inset >= 0

getRightInset

protected final short getRightInset()

Gets the right inset.

Returns:

the inset >= 0

getTopInset

protected final short getTopInset()

Gets the top inset.

Returns:

the inset >= 0

getBottomInset

protected final short getBottomInset()

Gets the bottom inset.

Returns:

the inset >= 0