Class TableView
- All Implemented Interfaces:
SwingConstants
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 independent spans if desired).
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionclass
Deprecated.A table cell can now be any View implementation.class
View of a row in a row-centric table. -
Field Summary
Fields declared in class View
BadBreakWeight, ExcellentBreakWeight, ForcedBreakWeight, GoodBreakWeight, X_AXIS, Y_AXIS
Modifier and TypeFieldDescriptionstatic final int
The weight to indicate a view is a bad break opportunity for the purpose of formatting.static final int
The weight to indicate a view supports breaking, and this represents a very attractive place to break.static final int
The weight to indicate a view supports breaking, and must be broken to be represented properly when placed in a view that formats its children by breaking them.static final int
The weight to indicate a view supports breaking, but better opportunities probably exist.static final int
Axis for format/break operations.static final int
Axis for format/break operations.Fields declared in interface SwingConstants
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST
Modifier and TypeFieldDescriptionstatic final int
Box-orientation constant used to specify the bottom of a box.static final int
The central position in an area.static final int
Compass-direction east (right).static final int
Horizontal orientation.static final int
Identifies the leading edge of text for use with left-to-right and right-to-left languages.static final int
Box-orientation constant used to specify the left side of a box.static final int
Identifies the next direction in a sequence.static final int
Compass-direction North (up).static final int
Compass-direction north-east (upper right).static final int
Compass-direction north west (upper left).static final int
Identifies the previous direction in a sequence.static final int
Box-orientation constant used to specify the right side of a box.static final int
Compass-direction south (down).static final int
Compass-direction south-east (lower right).static final int
Compass-direction south-west (lower left).static final int
Box-orientation constant used to specify the top of a box.static final int
Identifies the trailing edge of text for use with left-to-right and right-to-left languages.static final int
Vertical orientation.static final int
Compass-direction west (left). -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected SizeRequirements
calculateMinorAxisRequirements
(int axis, SizeRequirements r) Calculate the requirements for the minor axis.protected TableView.TableCell
createTableCell
(Element elem) Deprecated.Table cells can now be any arbitrary View implementation and should be produced by the ViewFactory rather than the table.protected TableView.TableRow
createTableRow
(Element elem) Creates a new table row.protected View
getViewAtPosition
(int pos, Rectangle a) Fetches the child view that represents the given position in the model.protected void
layoutColumns
(int targetSpan, int[] offsets, int[] spans, SizeRequirements[] reqs) Lays out the columns to fit within the given target 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 orthogonal to the axis that it represents).void
Change the child views.Methods declared in class BoxView
baselineLayout, baselineRequirements, calculateMajorAxisRequirements, childAllocation, flipEastAndWestAtEnds, forwardUpdate, getAlignment, getAxis, getChildAllocation, getHeight, getMaximumSpan, getMinimumSpan, getOffset, getPreferredSpan, getResizeWeight, getSpan, getViewAtPoint, getWidth, isAfter, isAllocationValid, isBefore, isLayoutValid, layout, layoutChanged, layoutMajorAxis, modelToView, paint, paintChild, preferenceChanged, setAxis, setSize, viewToModel
Modifier and TypeMethodDescriptionprotected void
baselineLayout
(int targetSpan, int axis, int[] offsets, int[] spans) Computes the location and extent of each child view in thisBoxView
given thetargetSpan
, which is the width (or height) of the region we have to work with.protected SizeRequirements
baselineRequirements
(int axis, SizeRequirements r) Calculates the size requirements for thisBoxView
by examining the size of each child view.protected SizeRequirements
calculateMajorAxisRequirements
(int axis, SizeRequirements r) Calculates the size requirements for the major axisaxis
.protected void
childAllocation
(int index, Rectangle alloc) Allocates a region for a child view.protected boolean
flipEastAndWestAtEnds
(int position, Position.Bias bias) Determines in which direction the next view lays.protected void
Forwards the givenDocumentEvent
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.getChildAllocation
(int index, Shape a) Fetches the allocation for the given child view.int
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.protected 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.protected int
getSpan
(int axis, int childIndex) Fetches the span of a particular child's current layout.protected 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.protected boolean
Determines if a point falls after an allocated region.protected boolean
Are the allocations for the children still valid?protected boolean
Determines if a point falls before an allocated region.protected boolean
isLayoutValid
(int axis) Determines if the layout is valid along the given axis.protected void
layout
(int width, int height) Perform layout on the boxvoid
layoutChanged
(int axis) Invalidates the layout along an axis.protected void
layoutMajorAxis
(int targetSpan, int axis, int[] offsets, int[] spans) Performs layout for the major axis of the box (i.e. the axis that it represents).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
Renders theBoxView
using the given rendering surface and area on that surface.protected 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
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, Position.Bias[] bias) Provides a mapping from the view coordinate space to the logical coordinate space of the model.Methods declared in class CompositeView
getBottomInset, getInsideAllocation, getLeftInset, getNextEastWestVisualPositionFrom, getNextNorthSouthVisualPositionFrom, getNextVisualPositionFrom, getRightInset, getTopInset, getView, getViewCount, getViewIndex, getViewIndexAtPosition, loadChildren, modelToView, setInsets, setParagraphInsets, setParent
Modifier and TypeMethodDescriptionprotected short
Gets the bottom inset.protected Rectangle
Translates the immutable allocation given to the view to a mutable allocation that represents the interior allocation (i.e. the bounds of the given allocation with the top, left, bottom, and right insets removed.protected short
Gets the left inset.protected int
getNextEastWestVisualPositionFrom
(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet) Returns the next visual position for the cursor, in either the east or west direction.protected int
getNextNorthSouthVisualPositionFrom
(int pos, Position.Bias b, Shape a, int direction, Position.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, Position.Bias[] biasRet) Provides a way to determine the next visually represented model location that one might place a caret.protected short
Gets the right inset.protected short
Gets the top inset.getView
(int n) Returns the n-th view in this container.int
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.protected int
getViewIndexAtPosition
(int pos) Fetches the child view index representing the given position in the model.protected void
Loads all of the children to initialize the view.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.protected void
setInsets
(short top, short left, short bottom, short right) Sets the insets for the view.protected void
Sets the insets from the paragraph attributes specified in the given attributes.void
Sets the parent of the view.Methods declared in class View
append, breakView, changedUpdate, createFragment, forwardUpdateToView, getAttributes, getBreakWeight, getContainer, getDocument, getElement, getEndOffset, getGraphics, getParent, getStartOffset, getToolTipText, getViewFactory, getViewIndex, insert, insertUpdate, isVisible, modelToView, remove, removeAll, removeUpdate, updateChildren, updateLayout, viewToModel
Modifier and TypeMethodDescriptionvoid
Appends a single child 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.createFragment
(int p0, int p1) Creates a view that represents a portion of the element.protected void
forwardUpdateToView
(View v, DocumentEvent e, Shape a, ViewFactory f) Forwards theDocumentEvent
to the give child view.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.Fetches the container hosting the view.Fetches the model associated with the view.Fetches the structural portion of the subject that this view is mapped to.int
Fetches the portion of the model for which this view is responsible.Fetch aGraphics
for rendering.Returns the parent of the view.int
Fetches the portion of the model for which this view is responsible.getToolTipText
(float x, float y, Shape allocation) Returns the tooltip text at the specified location.Fetches theViewFactory
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.void
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
Returns a boolean that indicates whether the view is visible or not.modelToView
(int pos, Shape a) Deprecated.void
remove
(int i) Removes one of the children at the given position.void
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.protected boolean
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.protected void
Updates the layout in response to receiving notification of change from the model.int
viewToModel
(float x, float y, Shape a) Deprecated.Methods declared in class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Modifier and TypeMethodDescriptionprotected Object
clone()
Creates and returns a copy of this object.boolean
Indicates whether some other object is "equal to" this one.protected void
finalize()
Deprecated, for removal: This API element is subject to removal in a future version.Finalization is deprecated and subject to removal in a future release.final Class
<?> getClass()
Returns the runtime class of thisObject
.int
hashCode()
Returns a hash code value for this object.final void
notify()
Wakes up a single thread that is waiting on this object's monitor.final void
Wakes up all threads that are waiting on this object's monitor.toString()
Returns a string representation of the object.final void
wait()
Causes the current thread to wait until it is awakened, typically by being notified or interrupted.final void
wait
(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.final void
wait
(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
-
Constructor Details
-
TableView
Constructs a TableView for the given element.- Parameters:
elem
- the element that this view is responsible for
-
-
Method Details
-
createTableRow
Creates a new table row.- Parameters:
elem
- an element- Returns:
- the row
-
createTableCell
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
-
replace
Change the child views. This is implemented to provide the superclass behavior and invalidate the grid so that rows and columns will be recalculated.- Overrides:
replace
in classBoxView
- Parameters:
offset
- the starting index into the child views to insert the new views; this should be a value >= 0 and <= getViewCountlength
- 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 benull
to indicate no children are being added (useful to remove)
-
layoutColumns
Lays out the columns to fit within the given target span. Returns the results throughoffsets
andspans
.- Parameters:
targetSpan
- the given span for total of all the table columnsoffsets
- the return value of the offset from the origin for each columnspans
- the return value of how much to allocated to each columnreqs
- the requirements desired for each column. This is the column maximum of the cells minimum, preferred, and maximum requested span
-
layoutMinorAxis
protected void layoutMinorAxis(int targetSpan, int axis, int[] offsets, int[] spans) Perform layout for the minor axis of the box (i.e. the axis orthogonal 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.- Overrides:
layoutMinorAxis
in classBoxView
- Parameters:
targetSpan
- the total span given to the view, which would be used to layout the children.axis
- the axis being laid 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.
-
calculateMinorAxisRequirements
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.
- Overrides:
calculateMinorAxisRequirements
in classBoxView
- Parameters:
axis
- the axis being studiedr
- theSizeRequirements
object; ifnull
one will be created- Returns:
- the newly initialized
SizeRequirements
object - See Also:
-
getViewAtPosition
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.- Overrides:
getViewAtPosition
in classCompositeView
- Parameters:
pos
- the search position >= 0a
- 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
-