javax.swing.text.CompositeView

public abstract class javax.swing.text

CompositeView

Java SE 6

Extends: View

Extended by: BoxView

CompositeView is an abstract View implementation which manages one or more child views. (Note that CompositeView is intended for managing relatively small numbers of child views.) CompositeView is intended to be used as a starting point for View implementations, such as BoxView, that will contain child Views. Subclasses that wish to manage the collection of child Views should use the #replace method. As View invokes replace during DocumentListener notification, you normally won't need to directly invoke replace.

While CompositeView does not impose a layout policy on its child Views, it does allow for inseting the child Views it will contain. The insets can be set by either #setInsets or #setParagraphInsets.

In addition to the abstract methods of javax.swing.text.View, subclasses of CompositeView will need to override:

#isBefore - Used to test if a given View location is before the visual space of the CompositeView.
#isAfter - Used to test if a given View location is after the visual space of the CompositeView.
#getViewAtPoint - Returns the view at a given visual location.
#childAllocation - Returns the bounds of a particular child View. getChildAllocation will invoke childAllocation after offseting the bounds by the Insets of the CompositeView.

version

1.69 04/07/06

Constructors

public

CompositeView(Element elem) Details

Constructs a CompositeView for the given element.

elem

the element this view is responsible for

Methods

abstract protected void

childAllocation(int index, Rectangle a) Details

Returns the allocation for a given child.

index	the index of the child, >= 0 && < getViewCount()the index of the child, >= 0 && < getViewCount()
a	the allocation to the interior of the box on entry, and the allocation of the child view at the index on exit.

protected boolean

flipEastAndWestAtEnds(int position, Position.Bias bias) Details

Determines in which direction the next view lays. Consider the View at index n. Typically the Views are layed out from left to right, so that the View to the EAST will be at index n + 1, and the View to the WEST will be at index n - 1. In certain situations, such as with bidirectional text, it is possible that the View to EAST is not at index n + 1, but rather at index n - 1, or that the View to the WEST is not at index n - 1, but index n + 1. In this case this method would return true, indicating the Views are layed out in descending order.

This unconditionally returns false, subclasses should override this method if there is the possibility for laying Views in descending order.

position position into the model

bias either Position.Bias.Forward or Position.Bias.Backward

return false

protected void

loadChildren(ViewFactory f) Details

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.

f	the view factory
See also	setParent

public Shape

modelToView(int pos, Shape a, Position.Bias b) throws BadLocationException Details

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

pos	the position to convert >= 0the position to convert >= 0
a	the allocated region to render into
b	a bias value of either `Position.Bias.Forward` or `Position.Bias.Backward`
return	the bounding box of the given position
Throws	BadLocationException: if the given position does not represent a valid location in the associated document
See also	modelToView

public Shape

modelToView(int p0, Position.Bias b0, int p1, Position.Bias b1, Shape a) throws BadLocationException Details

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

p0	the position to convert >= 0the position to convert >= 0
b0	the bias toward the previous character or the next character represented by p0, in case the position is a boundary of two views; either `Position.Bias.Forward` or `Position.Bias.Backward`
p1	the position to convert >= 0the position to convert >= 0
b1	the bias toward the previous character or the next character represented by p1, in case the position is a boundary of two views
a	the allocated region to render into
return	the bounding box of the given position is returned
Throws	BadLocationException: if the given position does not represent a valid location in the associated document
Throws	IllegalArgumentException: for an invalid bias argument
See also	viewToModel

public void

replace(int offset, int length, View[] views) Details

Replaces child views. If there are no views to remove this acts as an insert. If there are no views to add this acts as a remove. Views being removed will have the parent set to null, and the internal reference to them removed so that they may be garbage collected.

offset	the starting index into the child views to insert the new views; >= 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)

public int

viewToModel(float x, float y, Shape a, Position.Bias[] bias) Details

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

x	x coordinate of the view location to convert >= 0x coordinate of the view location to convert >= 0
y	y coordinate of the view location to convert >= 0y coordinate of the view location to convert >= 0
a	the allocated region to render into
bias	either `Position.Bias.Forward` or `Position.Bias.Backward`
return	the location within the model that best represents the given point in the view >= 0
See also	viewToModel

Properties

abstract protected boolean

isAfter(int x, int y, Rectangle alloc) Details

Tests whether a point lies after the rectangle range.

x	the X coordinate >= 0the X coordinate >= 0
y	the Y coordinate >= 0the Y coordinate >= 0
alloc	the rectangle
return	true if the point is after the specified range

abstract protected boolean

isBefore(int x, int y, Rectangle alloc) Details

Tests whether a point lies before the rectangle range.

x	the X coordinate >= 0the X coordinate >= 0
y	the Y coordinate >= 0the Y coordinate >= 0
alloc	the rectangle
return	true if the point is before the specified range

protected short

getBottomInset() Details

Gets the bottom inset.

return

the inset >= 0the inset >= 0

public Shape

getChildAllocation(int index, Shape a) Details

Fetches the allocation for the given child view to render into. This enables finding out where various views are located.

index	the index of the child, >= 0 && < getViewCount()the index of the child, >= 0 && < getViewCount()
a	the allocation to this view
return	the allocation to the child

protected void

setInsets(short top, short left, short bottom, short right) Details

Sets the insets for the view.

top	the top inset >= 0the top inset >= 0
left	the left inset >= 0the left inset >= 0
bottom	the bottom inset >= 0the bottom inset >= 0
right	the right inset >= 0the right inset >= 0

protected Rectangle

getInsideAllocation(Shape a) Details

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. It is expected that the returned value would be further mutated to represent an allocation to a child view. This is implemented to reuse an instance variable so it avoids creating excessive Rectangles. Typically the result of calling this method would be fed to the childAllocation method.

a	the allocation given to the view
return	the allocation that represents the inside of the view after the margins have all been removed; if the given allocation was `null`, the return value is `null`

protected short

getLeftInset() Details

Gets the left inset.

return

the inset >= 0the inset >= 0

protected int

getNextEastWestVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet) throws BadLocationException Details

Returns the next visual position for the cursor, in either the east or west direction.

pos	the position to convert >= 0the position to convert >= 0
b	a bias value of either `Position.Bias.Forward` or `Position.Bias.Backward`
a	the allocated region to render into
direction	the direction from the current position that can be thought of as the arrow keys typically found on a keyboard; this may be one of the following: `SwingConstants.WEST` `SwingConstants.EAST`
biasRet	an array containing the bias that was checked
return	the location within the model that best represents the next west or east location
Throws	BadLocationException:
Throws	IllegalArgumentException: if `direction` is invalid
See also	getNextVisualPositionFrom

protected int

getNextNorthSouthVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet) throws BadLocationException Details

Returns the next visual position for the cursor, in either the north or south direction.

pos	the position to convert >= 0the position to convert >= 0
b	a bias value of either `Position.Bias.Forward` or `Position.Bias.Backward`
a	the allocated region to render into
direction	the direction from the current position that can be thought of as the arrow keys typically found on a keyboard; this may be one of the following: `SwingConstants.NORTH` `SwingConstants.SOUTH`
biasRet	an array containing the bias that was checked
return	the location within the model that best represents the next north or south location
Throws	BadLocationException:
Throws	IllegalArgumentException: if `direction` is invalid
return	the next position west of the passed in position
See also	getNextVisualPositionFrom

public int

getNextVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet) throws BadLocationException Details

Provides a way to determine the next visually represented model location that one might place a caret. Some views may not be visible, they might not be in the same order found in the model, or they just might not allow access to some of the locations in the model. This is a convenience method for #getNextNorthSouthVisualPositionFrom and #getNextEastWestVisualPositionFrom.

pos	the position to convert >= 0the position to convert >= 0
b	a bias value of either `Position.Bias.Forward` or `Position.Bias.Backward`
a	the allocated region to render into
direction	the direction from the current position that can be thought of as the arrow keys typically found on a keyboard; this may be one of the following: `SwingConstants.WEST` `SwingConstants.EAST` `SwingConstants.NORTH` `SwingConstants.SOUTH`
biasRet	an array containing the bias that was checked
return	the location within the model that best represents the next location visual position
Throws	BadLocationException:
Throws	IllegalArgumentException: if `direction` is invalid

protected void

setParagraphInsets(AttributeSet attr) Details

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

attr

the attributes

public void

setParent(View parent) Details

Sets the parent of the view. This is reimplemented to provide the superclass behavior as well as calling the loadChildren method if this view does not already have children. 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). If this view has children (the view is being moved from one place in the view hierarchy to another), the loadChildren method will not be called.

parent the parent of the view, null if none

protected short

getRightInset() Details

Gets the right inset.

return

the inset >= 0the inset >= 0

protected short

getTopInset() Details

Gets the top inset.

return

the inset >= 0the inset >= 0

public View

getView(int n) Details

Returns the n-th view in this container.

n	the number of the desired view, >= 0 && < getViewCount()the number of the desired view, >= 0 && < getViewCount()
return	the view at index `n`

abstract protected View

getViewAtPoint(int x, int y, Rectangle alloc) Details

Fetches the child view at the given coordinates.

x	the X coordinate >= 0the X coordinate >= 0
y	the Y coordinate >= 0the Y coordinate >= 0
alloc	the parent's allocation on entry, which should be changed to the child's allocation on exit
return	the child view

protected View

getViewAtPosition(int pos, Rectangle a) Details

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.

pos	the position >= 0the position >= 0
a	the allocation to the interior of the box on entry, and the allocation of the view containing the position on exit
return	the view representing the given position, or `null` if there isn't one

public int

getViewCount() Details

Returns the number of child views of this view.

return	the number of views >= 0the number of views >= 0
See also	getView

public int

getViewIndex(int pos, Position.Bias b) Details

Returns the child view index representing the given position in the model. This is implemented to call the getViewIndexByPosition method for backward compatibility.

pos	the position >= 0the position >= 0
return	index of the view representing the given position, or -1 if no view represents that position
since	1.3

protected int

getViewIndexAtPosition(int pos) Details

Fetches the child view index representing 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.

pos	the position >= 0the position >= 0
return	index of the view representing the given position, or -1 if no view represents that position

About DocWeb · Bundles · Export · Export All

Top 10 · Statistics · Login

About Sun · Contact · Privacy · Terms of Use · Trademarks

Java SE 6

· Copyright © 1994-2013 Sun Microsystems, Inc.
All rights reserved. Use is subject to license terms