- java.lang.Object
-
- javax.swing.text.View
-
- javax.swing.text.CompositeView
-
- All Implemented Interfaces:
SwingConstants
- Direct Known Subclasses:
BoxView
public abstract class CompositeView extends View
CompositeViewis an abstractViewimplementation which manages one or more child views. (Note thatCompositeViewis intended for managing relatively small numbers of child views.)CompositeViewis intended to be used as a starting point forViewimplementations, such asBoxView, that will contain childViews. Subclasses that wish to manage the collection of childViews should use thereplace(int, int, javax.swing.text.View[])method. AsViewinvokesreplaceduringDocumentListenernotification, you normally won't need to directly invokereplace.While
CompositeViewdoes not impose a layout policy on its childViews, it does allow for inseting the childViews it will contain. The insets can be set by eithersetInsets(short, short, short, short)orsetParagraphInsets(javax.swing.text.AttributeSet).In addition to the abstract methods of
View, subclasses ofCompositeViewwill need to override:isBefore(int, int, java.awt.Rectangle)- Used to test if a givenViewlocation is before the visual space of theCompositeView.isAfter(int, int, java.awt.Rectangle)- Used to test if a givenViewlocation is after the visual space of theCompositeView.getViewAtPoint(int, int, java.awt.Rectangle)- Returns the view at a given visual location.childAllocation(int, java.awt.Rectangle)- Returns the bounds of a particular childView.getChildAllocationwill invokechildAllocationafter offseting the bounds by theInsets of theCompositeView.
-
-
Field Summary
-
Fields declared in class javax.swing.text.View
BadBreakWeight, ExcellentBreakWeight, ForcedBreakWeight, GoodBreakWeight, X_AXIS, Y_AXIS
-
Fields declared in interface javax.swing.SwingConstants
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST
-
-
Constructor Summary
Constructors Constructor Description CompositeView(Element elem)Constructs aCompositeViewfor the given element.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected abstract voidchildAllocation(int index, Rectangle a)Returns the allocation for a given child.protected booleanflipEastAndWestAtEnds(int position, Position.Bias bias)Determines in which direction the next view lays.protected shortgetBottomInset()Gets the bottom inset.ShapegetChildAllocation(int index, Shape a)Fetches the allocation for the given child view to render into.protected RectanglegetInsideAllocation(Shape a)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 shortgetLeftInset()Gets the left inset.protected intgetNextEastWestVisualPositionFrom(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 intgetNextNorthSouthVisualPositionFrom(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.intgetNextVisualPositionFrom(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 shortgetRightInset()Gets the right inset.protected shortgetTopInset()Gets the top inset.ViewgetView(int n)Returns the n-th view in this container.protected abstract ViewgetViewAtPoint(int x, int y, Rectangle alloc)Fetches the child view at the given coordinates.protected ViewgetViewAtPosition(int pos, Rectangle a)Fetches the child view that represents the given position in the model.intgetViewCount()Returns the number of child views of this view.intgetViewIndex(int pos, Position.Bias b)Returns the child view index representing the given position in the model.protected intgetViewIndexAtPosition(int pos)Fetches the child view index representing the given position in the model.protected abstract booleanisAfter(int x, int y, Rectangle alloc)Tests whether a point lies after the rectangle range.protected abstract booleanisBefore(int x, int y, Rectangle alloc)Tests whether a point lies before the rectangle range.protected voidloadChildren(ViewFactory f)Loads all of the children to initialize the view.ShapemodelToView(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.ShapemodelToView(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.voidreplace(int offset, int length, View[] views)Replaces child views.protected voidsetInsets(short top, short left, short bottom, short right)Sets the insets for the view.protected voidsetParagraphInsets(AttributeSet attr)Sets the insets from the paragraph attributes specified in the given attributes.voidsetParent(View parent)Sets the parent of the view.intviewToModel(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 javax.swing.text.View
append, breakView, changedUpdate, createFragment, forwardUpdate, forwardUpdateToView, getAlignment, getAttributes, getBreakWeight, getContainer, getDocument, getElement, getEndOffset, getGraphics, getMaximumSpan, getMinimumSpan, getParent, getPreferredSpan, getResizeWeight, getStartOffset, getToolTipText, getViewFactory, getViewIndex, insert, insertUpdate, isVisible, modelToView, paint, preferenceChanged, remove, removeAll, removeUpdate, setSize, updateChildren, updateLayout, viewToModel
-
-
-
-
Constructor Detail
-
CompositeView
public CompositeView(Element elem)
Constructs aCompositeViewfor 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 thesetParent(javax.swing.text.View)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- See Also:
setParent(javax.swing.text.View)
-
setParent
public void setParent(View parent)
Sets the parent of the view. This is reimplemented to provide the superclass behavior as well as calling theloadChildrenmethod 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 hostingContainerfor example). If this view has children (the view is being moved from one place in the view hierarchy to another), theloadChildrenmethod will not be called.
-
getViewCount
public int getViewCount()
Returns the number of child views of this view.- Overrides:
getViewCountin classView- Returns:
- the number of views >= 0
- See Also:
getView(int)
-
getView
public View getView(int n)
Returns the n-th view in this container.
-
replace
public void replace(int offset, int length, View[] views)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 tonull, and the internal reference to them removed so that they may be garbage collected.- Overrides:
replacein classView- Parameters:
offset- the starting index into the child views to insert the new views; >= 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 benullto indicate no children are being added (useful to remove)
-
getChildAllocation
public Shape getChildAllocation(int index, Shape a)
Fetches the allocation for the given child view to render into. This enables finding out where various views are located.- Overrides:
getChildAllocationin classView- Parameters:
index- the index of the child, >= 0 && < getViewCount()a- the allocation to this view- Returns:
- the allocation to the child
-
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.- Specified by:
modelToViewin classView- Parameters:
pos- the position to convert >= 0a- the allocated region to render intob- a bias value of eitherPosition.Bias.ForwardorPosition.Bias.Backward- Returns:
- 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:
View.modelToView(int, java.awt.Shape, javax.swing.text.Position.Bias)
-
modelToView
public Shape modelToView(int p0, Position.Bias b0, int p1, Position.Bias b1, Shape a) throws BadLocationException
Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it.- Overrides:
modelToViewin classView- Parameters:
p0- the position to convert >= 0b0- the bias toward the previous character or the next character represented by p0, in case the position is a boundary of two views; eitherPosition.Bias.ForwardorPosition.Bias.Backwardp1- the position to convert >= 0b1- the bias toward the previous character or the next character represented by p1, in case the position is a boundary of two viewsa- the allocated region to render into- Returns:
- the bounding box of the given position is returned
- Throws:
BadLocationException- if the given position does not represent a valid location in the associated documentIllegalArgumentException- for an invalid bias argument- See Also:
View.viewToModel(float, float, java.awt.Shape, javax.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.- Specified by:
viewToModelin classView- Parameters:
x- x coordinate of the view location to convert >= 0y- y coordinate of the view location to convert >= 0a- the allocated region to render intobias- eitherPosition.Bias.ForwardorPosition.Bias.Backward- Returns:
- the location within the model that best represents the given point in the view >= 0
- See Also:
View.viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[])
-
getNextVisualPositionFrom
public int getNextVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet) throws BadLocationExceptionProvides 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 forgetNextNorthSouthVisualPositionFrom(int, javax.swing.text.Position.Bias, java.awt.Shape, int, javax.swing.text.Position.Bias[])andgetNextEastWestVisualPositionFrom(int, javax.swing.text.Position.Bias, java.awt.Shape, int, javax.swing.text.Position.Bias[]). This method enables specifying a position to convert within the range of >=0. If the value is -1, a position will be calculated automatically. If the value < -1, theBadLocationExceptionwill be thrown.- Overrides:
getNextVisualPositionFromin classView- Parameters:
pos- the position to convertb- a bias value of eitherPosition.Bias.ForwardorPosition.Bias.Backwarda- the allocated region to render intodirection- 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.WESTSwingConstants.EASTSwingConstants.NORTHSwingConstants.SOUTH
biasRet- an array containing the bias that was checked- Returns:
- the location within the model that best represents the next location visual position
- Throws:
BadLocationException- the given position is not a valid position within the documentIllegalArgumentException- ifdirectionis invalid
-
getViewIndex
public int getViewIndex(int pos, Position.Bias b)Returns the child view index representing the given position in the model. This is implemented to call thegetViewIndexByPositionmethod for backward compatibility.- Overrides:
getViewIndexin classView- Parameters:
pos- the position >= 0b- the bias- Returns:
- index of the view representing the given position, or -1 if no view represents that position
- Since:
- 1.3
-
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 >= 0y- the Y coordinate >= 0alloc- 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 >= 0y- the Y coordinate >= 0alloc- 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 coordinates.- Parameters:
x- the X coordinate >= 0y- the Y coordinate >= 0alloc- 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 child view at the index 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 >= 0a- the allocation to the interior of the box on entry, and the allocation of the view containing the position on exit- Returns:
- the view representing the given position, or
nullif there isn't one
-
getViewIndexAtPosition
protected int getViewIndexAtPosition(int pos)
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.- Parameters:
pos- the position >= 0- Returns:
- index of the view representing the given position, or -1 if no view represents that position
-
getInsideAllocation
protected Rectangle getInsideAllocation(Shape a)
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 thechildAllocationmethod.- Parameters:
a- the allocation given to the view- Returns:
- 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 isnull
-
setParagraphInsets
protected void setParagraphInsets(AttributeSet attr)
Sets the insets from the paragraph attributes specified in the given attributes.- Parameters:
attr- the attributes
-
setInsets
protected void setInsets(short top, short left, short bottom, short right)Sets the insets for the view.- Parameters:
top- the top inset >= 0left- the left inset >= 0bottom- the bottom inset >= 0right- the right inset >= 0
-
getLeftInset
protected short getLeftInset()
Gets the left inset.- Returns:
- the inset >= 0
-
getRightInset
protected short getRightInset()
Gets the right inset.- Returns:
- the inset >= 0
-
getTopInset
protected short getTopInset()
Gets the top inset.- Returns:
- the inset >= 0
-
getBottomInset
protected short getBottomInset()
Gets the bottom inset.- Returns:
- the inset >= 0
-
getNextNorthSouthVisualPositionFrom
protected int getNextNorthSouthVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet) throws BadLocationExceptionReturns the next visual position for the cursor, in either the north or south direction.- Parameters:
pos- the position to convert >= 0b- a bias value of eitherPosition.Bias.ForwardorPosition.Bias.Backwarda- the allocated region to render intodirection- 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.NORTHSwingConstants.SOUTH
biasRet- an array containing the bias that was checked- Returns:
- the location within the model that best represents the next north or south location
- Throws:
BadLocationException- for a bad location within a document modelIllegalArgumentException- ifdirectionis invalid- See Also:
getNextVisualPositionFrom(int, javax.swing.text.Position.Bias, java.awt.Shape, int, javax.swing.text.Position.Bias[])
-
getNextEastWestVisualPositionFrom
protected int getNextEastWestVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet) throws BadLocationExceptionReturns the next visual position for the cursor, in either the east or west direction.- Parameters:
pos- the position to convert >= 0b- a bias value of eitherPosition.Bias.ForwardorPosition.Bias.Backwarda- the allocated region to render intodirection- 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.WESTSwingConstants.EAST
biasRet- an array containing the bias that was checked- Returns:
- the location within the model that best represents the next west or east location
- Throws:
BadLocationException- for a bad location within a document modelIllegalArgumentException- ifdirectionis invalid- See Also:
getNextVisualPositionFrom(int, javax.swing.text.Position.Bias, java.awt.Shape, int, javax.swing.text.Position.Bias[])
-
flipEastAndWestAtEnds
protected boolean flipEastAndWestAtEnds(int position, Position.Bias bias)Determines in which direction the next view lays. Consider theViewat index n. Typically theViews are layed out from left to right, so that theViewto the EAST will be at index n + 1, and theViewto the WEST will be at index n - 1. In certain situations, such as with bidirectional text, it is possible that theViewto EAST is not at index n + 1, but rather at index n - 1, or that theViewto the WEST is not at index n - 1, but index n + 1. In this case this method would return true, indicating theViews 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.- Parameters:
position- position into the modelbias- eitherPosition.Bias.ForwardorPosition.Bias.Backward- Returns:
- false
-
-