public abstract class

TableView

extends BoxView

java.lang.Object
↳	javax.swing.text.View
	↳	javax.swing.text.CompositeView
		↳	javax.swing.text.BoxView
			↳	javax.swing.text.TableView

Class Overview

Implements View interface for a table, that is composed of an element structure where the child elements of the element this view is responsible for represent rows and the child elements of the row elements are cells. The cell elements can have an arbitrary element structure under them, which will be built with the ViewFactory returned by the getViewFactory method.


    TABLE
      ROW
        CELL
        CELL
      ROW
        CELL
        CELL

This is implemented as a hierarchy of boxes, the table itself is a vertical box, the rows are horizontal boxes, and the cells are vertical boxes. The cells are allowed to span multiple columns and rows. By default, the table can be thought of as being formed over a grid (i.e. somewhat like one would find in gridbag layout), where table cells can request to span more than one grid cell. The default horizontal span of table cells will be based upon this grid, but can be changed by reimplementing the requested span of the cell (i.e. table cells can have independant spans if desired).

Summary

Nested Classes
class	TableView.TableCell	This class is deprecated. A table cell can now be any View implementation.
class	TableView.TableRow	View of a row in a row-centric table.

[Expand]

Inherited Constants

From class javax.swing.text.View

From interface javax.swing.SwingConstants

Public Constructors
	TableView(Element elem) Constructs a TableView for the given element.

Public Methods
void	replace(int offset, int length, View[] views) Change the child views.

Protected Methods
SizeRequirements	calculateMinorAxisRequirements(int axis, SizeRequirements r) Calculate the requirements for the minor axis.
TableView.TableCell	createTableCell(Element elem) This method is deprecated. Table cells can now be any arbitrary View implementation and should be produced by the ViewFactory rather than the table.
TableView.TableRow	createTableRow(Element elem) Creates a new table row.
void	forwardUpdate(DocumentEvent.ElementChange ec, DocumentEvent e, Shape a, ViewFactory f) Forwards the given `DocumentEvent` to the child views that need to be notified of the change to the model.
View	getViewAtPosition(int pos, Rectangle a) Fetches the child view that represents the given position in the model.
void	layoutColumns(int targetSpan, int[] offsets, int[] spans, SizeRequirements[] reqs) Lays out the columns to fit within the given target span.
void	layoutMinorAxis(int targetSpan, int axis, int[] offsets, int[] spans) Perform layout for the minor axis of the box (i.e.

[Expand]

Inherited Methods

From class javax.swing.text.BoxView

void	baselineLayout(int targetSpan, int axis, int[] offsets, int[] spans) Computes the location and extent of each child view in this `BoxView` given the `targetSpan`, which is the width (or height) of the region we have to work with.
SizeRequirements	baselineRequirements(int axis, SizeRequirements r) Calculates the size requirements for this `BoxView` by examining the size of each child view.
SizeRequirements	calculateMajorAxisRequirements(int axis, SizeRequirements r) Calculates the size requirements for the major axis `axis`.
SizeRequirements	calculateMinorAxisRequirements(int axis, SizeRequirements r) Calculates the size requirements for the minor axis `axis`.
void	childAllocation(int index, Rectangle alloc) Allocates a region for a child view.
boolean	flipEastAndWestAtEnds(int position, Position.Bias bias) Determines in which direction the next view lays.
void	forwardUpdate(DocumentEvent.ElementChange ec, DocumentEvent e, Shape a, ViewFactory f) Forwards the given `DocumentEvent` to the child views that need to be notified of the change to the model.
float	getAlignment(int axis) Determines the desired alignment for this view along an axis.
int	getAxis() Fetches the tile axis property.
Shape	getChildAllocation(int index, Shape a) Fetches the allocation for the given child view.
int	getHeight() Returns the current height of the box.
float	getMaximumSpan(int axis) Determines the maximum span for this view along an axis.
float	getMinimumSpan(int axis) Determines the minimum span for this view along an axis.
int	getOffset(int axis, int childIndex) Fetches the offset of a particular child's current layout.
float	getPreferredSpan(int axis) Determines the preferred span for this view along an axis.
int	getResizeWeight(int axis) Gets the resize weight.
int	getSpan(int axis, int childIndex) Fetches the span of a particular childs current layout.
View	getViewAtPoint(int x, int y, Rectangle alloc) Fetches the child view at the given coordinates.
int	getWidth() Returns the current width of the box.
boolean	isAfter(int x, int y, Rectangle innerAlloc) Determines if a point falls after an allocated region.
boolean	isAllocationValid() Are the allocations for the children still valid?
boolean	isBefore(int x, int y, Rectangle innerAlloc) Determines if a point falls before an allocated region.
boolean	isLayoutValid(int axis) Determines if the layout is valid along the given axis.
void	layout(int width, int height) Perform layout on the box
void	layoutChanged(int axis) Invalidates the layout along an axis.
void	layoutMajorAxis(int targetSpan, int axis, int[] offsets, int[] spans) Performs layout for the major axis of the box (i.e.
void	layoutMinorAxis(int targetSpan, int axis, int[] offsets, int[] spans) Performs layout for the minor axis of the box (i.e.
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	paint(Graphics g, Shape allocation) Renders the `BoxView` using the given rendering surface and area on that surface.
void	paintChild(Graphics g, Rectangle alloc, int index) Paints a child.
void	preferenceChanged(View child, boolean width, boolean height) This is called by a child to indicate its preferred span has changed.
void	replace(int index, int length, View[] elems) Invalidates the layout and resizes the cache of requests/allocations.
void	setAxis(int axis) Sets the tile axis property.
void	setSize(float width, float height) Sets the size of the view.
int	viewToModel(float x, float y, Shape a, Bias[] bias) Provides a mapping from the view coordinate space to the logical coordinate space of the model.

From class javax.swing.text.CompositeView

abstract void	childAllocation(int index, Rectangle a) Returns the allocation for a given child.
boolean	flipEastAndWestAtEnds(int position, Position.Bias bias) Determines in which direction the next view lays.
short	getBottomInset() Gets the bottom inset.
Shape	getChildAllocation(int index, Shape a) Fetches the allocation for the given child view to render into.
Rectangle	getInsideAllocation(Shape a) Translates the immutable allocation given to the view to a mutable allocation that represents the interior allocation (i.e.
short	getLeftInset() Gets the left inset.
int	getNextEastWestVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Bias[] biasRet) Returns the next visual position for the cursor, in either the east or west direction.
int	getNextNorthSouthVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Bias[] biasRet) Returns the next visual position for the cursor, in either the north or south direction.
int	getNextVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Bias[] biasRet) Provides a way to determine the next visually represented model location that one might place a caret.
short	getRightInset() Gets the right inset.
short	getTopInset() Gets the top inset.
View	getView(int n) Returns the n-th view in this container.
abstract View	getViewAtPoint(int x, int y, Rectangle alloc) Fetches the child view at the given coordinates.
View	getViewAtPosition(int pos, Rectangle a) Fetches the child view that represents the given position in the model.
int	getViewCount() Returns the number of child views of this view.
int	getViewIndex(int pos, Position.Bias b) Returns the child view index representing the given position in the model.
int	getViewIndexAtPosition(int pos) Fetches the child view index representing the given position in the model.
abstract boolean	isAfter(int x, int y, Rectangle alloc) Tests whether a point lies after the rectangle range.
abstract boolean	isBefore(int x, int y, Rectangle alloc) Tests whether a point lies before the rectangle range.
void	loadChildren(ViewFactory f) Loads all of the children to initialize the view.
Shape	modelToView(int p0, Position.Bias b0, int p1, Position.Bias b1, Shape a) Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it.
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	replace(int offset, int length, View[] views) Replaces child views.
void	setInsets(short top, short left, short bottom, short right) Sets the insets for the view.
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, Bias[] bias) Provides a mapping from the view coordinate space to the logical coordinate space of the model.

From class javax.swing.text.View

void	append(View v) Appends a single child view.
View	breakView(int axis, int offset, float pos, float len) Tries to break this view on the given axis.
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.
View	createFragment(int p0, int p1) Creates a view that represents a portion of the element.
void	forwardUpdate(DocumentEvent.ElementChange ec, DocumentEvent e, Shape a, ViewFactory f) Forwards the given `DocumentEvent` to the child views that need to be notified of the change to the model.
void	forwardUpdateToView(View v, DocumentEvent e, Shape a, ViewFactory f) Forwards the `DocumentEvent` to the give child view.
float	getAlignment(int axis) Determines the desired alignment for this view along an axis.
AttributeSet	getAttributes() Fetches the attributes to use when rendering.
int	getBreakWeight(int axis, float pos, float len) Determines how attractive a break opportunity in this view is.
Shape	getChildAllocation(int index, Shape a) Fetches the allocation for the given child view.
Container	getContainer() Fetches the container hosting the view.
Document	getDocument() Fetches the model associated with the view.
Element	getElement() Fetches the structural portion of the subject that this view is mapped to.
int	getEndOffset() Fetches the portion of the model for which this view is responsible.
Graphics	getGraphics() Fetch a `Graphics` for rendering.
float	getMaximumSpan(int axis) Determines the maximum span for this view along an axis.
float	getMinimumSpan(int axis) Determines the minimum span for this view along an axis.
int	getNextVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Bias[] biasRet) Provides a way to determine the next visually represented model location at which one might place a caret.
View	getParent() Returns the parent of the view.
abstract float	getPreferredSpan(int axis) Determines the preferred span for this view along an axis.
int	getResizeWeight(int axis) Determines the resizability of the view along the given axis.
int	getStartOffset() Fetches the portion of the model for which this view is responsible.
String	getToolTipText(float x, float y, Shape allocation) Returns the tooltip text at the specified location.
View	getView(int n) Gets the nth child view.
int	getViewCount() Returns the number of views in this view.
ViewFactory	getViewFactory() Fetches the `ViewFactory` implementation that is feeding the view hierarchy.
int	getViewIndex(float x, float y, Shape allocation) Returns the child view index representing the given position in the view.
int	getViewIndex(int pos, Position.Bias b) Returns the child view index representing the given position in the model.
void	insert(int offs, View v) Inserts a single child view.
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.
boolean	isVisible() Returns a boolean that indicates whether the view is visible or not.
Shape	modelToView(int p0, Position.Bias b0, int p1, Position.Bias b1, Shape a) Provides a mapping, for a given region, from the document model coordinate space to the view coordinate space.
Shape	modelToView(int pos, Shape a) This method is deprecated. No replacement.
abstract Shape	modelToView(int pos, Shape a, Position.Bias b) Provides a mapping, for a given character, from the document model coordinate space to the view coordinate space.
abstract void	paint(Graphics g, Shape allocation) Renders using the given rendering surface and area on that surface.
void	preferenceChanged(View child, boolean width, boolean height) Child views can call this on the parent to indicate that the preference has changed and should be reconsidered for layout.
void	remove(int i) Removes one of the children at the given position.
void	removeAll() Removes all of the children.
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.
void	replace(int offset, int length, View[] views) Replaces child views.
void	setParent(View parent) Establishes the parent view for this view.
void	setSize(float width, float height) Sets the size of the view.
boolean	updateChildren(DocumentEvent.ElementChange ec, DocumentEvent e, ViewFactory f) Updates the child views in response to receiving notification that the model changed, and there is change record for the element this view is responsible for.
void	updateLayout(DocumentEvent.ElementChange ec, DocumentEvent e, Shape a) Updates the layout in response to receiving notification of change from the model.
int	viewToModel(float x, float y, Shape a) This method is deprecated. No replacement.
abstract int	viewToModel(float x, float y, Shape a, Bias[] biasReturn) Provides a mapping from the view coordinate space to the logical coordinate space of the model.

From class java.lang.Object

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
final Class<?>	getClass() Returns the runtime class of this `Object`.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait() Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
final void	wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.

Public Constructors

public TableView (Element elem)

Constructs a TableView for the given element.

Parameters

elem	the element that this view is responsible for

Public Methods

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

Change the child views. This is implemented to provide the superclass behavior and invalidate the grid so that rows and columns will be recalculated.

Parameters

offset	the starting index into the child views to insert the new views; this should be a value >= 0 and <= getViewCount
length	the number of existing child views to remove; This should be a value >= 0 and <= (getViewCount() - offset)
views	the child views to add; this value can be `null`to indicate no children are being added (useful to remove)

Protected Methods

protected SizeRequirements calculateMinorAxisRequirements (int axis, SizeRequirements r)

Calculate the requirements for the minor axis. This is called by the superclass whenever the requirements need to be updated (i.e. a preferenceChanged was messaged through this view).

This is implemented to calculate the requirements as the sum of the requirements of the columns.

Parameters

axis	the axis being studied
r	the `SizeRequirements` object; if `null` one will be created

Returns

the newly initialized SizeRequirements object

protected TableView.TableCell createTableCell (Element elem)

This method is deprecated.
Table cells can now be any arbitrary View implementation and should be produced by the ViewFactory rather than the table.

Parameters

elem	an element

Returns

the cell

protected TableView.TableRow createTableRow (Element elem)

Creates a new table row.

Parameters

elem	an element

Returns

the row

protected void forwardUpdate (DocumentEvent.ElementChange ec, DocumentEvent e, Shape a, ViewFactory f)

Forwards the given DocumentEvent to the child views that need to be notified of the change to the model. If a child changed its requirements and the allocation was valid prior to forwarding the portion of the box from the starting child to the end of the box will be repainted.

Parameters

ec	changes to the element this view is responsible for (may be `null` if there were no changes)
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

protected View getViewAtPosition (int pos, Rectangle a)

Fetches the child view that represents the given position in the model. This is implemented to walk through the children looking for a range that contains the given position. In this view the children do not necessarily have a one to one mapping with the child elements.

Parameters

pos	the search position >= 0
a	the allocation to the table on entry, and the allocation of the view containing the position on exit

Returns

the view representing the given position, or null if there isn't one

protected void layoutColumns (int targetSpan, int[] offsets, int[] spans, SizeRequirements[] reqs)

Lays out the columns to fit within the given target span. Returns the results through offsets and spans.

Parameters

targetSpan	the given span for total of all the table columns
offsets	the return value of the offset from the origin for each column
spans	the return value of how much to allocated to each column
reqs	the requirements desired for each column. This is the column maximum of the cells minimum, preferred, and maximum requested span

protected void layoutMinorAxis (int targetSpan, int axis, int[] offsets, int[] spans)

Perform layout for the minor axis of the box (i.e. the axis orthoginal to the axis that it represents). The results of the layout should be placed in the given arrays which represent the allocations to the children along the minor axis. This is called by the superclass whenever the layout needs to be updated along the minor axis.

This is implemented to call the layoutColumns method, and then forward to the superclass to actually carry out the layout of the tables rows.

Parameters

targetSpan	the total span given to the view, which whould be used to layout the children.
axis	the axis being layed out.
offsets	the offsets from the origin of the view for each of the child views. This is a return value and is filled in by the implementation of this method.
spans	the span of each child view. This is a return value and is filled in by the implementation of this method.

Interfaces

Classes

Exceptions

TableView

Class Overview

See Also

Summary

Public Constructors

public TableView (Element elem)

Parameters

Public Methods

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

Parameters

Protected Methods

protected SizeRequirements calculateMinorAxisRequirements (int axis, SizeRequirements r)

Parameters

Returns

protected TableView.TableCell createTableCell (Element elem)

Parameters

Returns

protected TableView.TableRow createTableRow (Element elem)

Parameters

Returns

protected void forwardUpdate (DocumentEvent.ElementChange ec, DocumentEvent e, Shape a, ViewFactory f)

Parameters

protected View getViewAtPosition (int pos, Rectangle a)

Parameters

Returns

protected void layoutColumns (int targetSpan, int[] offsets, int[] spans, SizeRequirements[] reqs)

Parameters

protected void layoutMinorAxis (int targetSpan, int axis, int[] offsets, int[] spans)

Parameters