SwingConstants
public class ZoneView extends BoxView
ZoneView extends BoxView to provide a box that implements zones for its children. The zones are special View implementations (the children of an instance of this class) that represent only a portion of the model that an instance of ZoneView is responsible for. The zones don't create child views until an attempt is made to display them. A box shaped view is well suited to this because:
The default behavior is controlled by two properties, maxZoneSize and maxZonesLoaded. Setting maxZoneSize to Integer.MAX_VALUE would have the effect of causing only one zone to be created. This would effectively turn the view into an implementation of the decorator pattern. Setting maxZonesLoaded to a value of Integer.MAX_VALUE would cause zones to never be unloaded. For simplicity, zones are created on boundaries represented by the child elements of the element the view is responsible for. The zones can be any View implementation, but the default implementation is based upon AsyncBoxView which supports fairly large zones efficiently.
BadBreakWeight, ExcellentBreakWeight, ForcedBreakWeight, GoodBreakWeight, X_AXIS, Y_AXIS
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST
Constructor | Description |
---|---|
ZoneView |
Constructs a ZoneView. |
Modifier and Type | Method | Description |
---|---|---|
protected View |
createZone |
Create a view to represent a zone for the given range within the model (which should be within the range of this objects responsibility). |
int |
getMaximumZoneSize() |
Get the current maximum zone size. |
int |
getMaxZonesLoaded() |
Get the current setting of the number of zones allowed to be loaded at the same time. |
protected int |
getViewIndexAtPosition |
Returns the child view index representing the given position in the model. |
void |
insertUpdate |
Gives notification that something was inserted into the document in a location that this view is responsible for. |
protected boolean |
isZoneLoaded |
Determine if a zone is in the loaded state. |
protected void |
loadChildren |
Loads all of the children to initialize the view. |
void |
removeUpdate |
Gives notification that something was removed from the document in a location that this view is responsible for. |
void |
setMaximumZoneSize |
Set the desired maximum zone size. |
void |
setMaxZonesLoaded |
Sets the current setting of the number of zones allowed to be loaded at the same time. |
protected void |
unloadZone |
Unload a zone (Convert the zone to its memory saving state). |
protected boolean |
updateChildren |
The superclass behavior will try to update the child views which is not desired in this case, since the children are zones and not directly effected by the changes to the associated element. |
protected void |
zoneWasLoaded |
Called by a zone when it gets loaded. |
baselineLayout, baselineRequirements, calculateMajorAxisRequirements, calculateMinorAxisRequirements, childAllocation, flipEastAndWestAtEnds, forwardUpdate, getAlignment, getAxis, getChildAllocation, getHeight, getMaximumSpan, getMinimumSpan, getOffset, getPreferredSpan, getResizeWeight, getSpan, getViewAtPoint, getWidth, isAfter, isAllocationValid, isBefore, isLayoutValid, layout, layoutChanged, layoutMajorAxis, layoutMinorAxis, modelToView, paint, paintChild, preferenceChanged, replace, setAxis, setSize, viewToModel
getBottomInset, getInsideAllocation, getLeftInset, getNextEastWestVisualPositionFrom, getNextNorthSouthVisualPositionFrom, getNextVisualPositionFrom, getRightInset, getTopInset, getView, getViewAtPosition, getViewCount, getViewIndex, modelToView, setInsets, setParagraphInsets, setParent
append, breakView, changedUpdate, createFragment, forwardUpdateToView, getAttributes, getBreakWeight, getContainer, getDocument, getElement, getEndOffset, getGraphics, getParent, getStartOffset, getToolTipText, getViewFactory, getViewIndex, insert, isVisible, modelToView, remove, removeAll, updateLayout, viewToModel
public ZoneView(Element elem, int axis)
elem
- the element this view is responsible foraxis
- either View.X_AXIS or View.Y_AXISpublic int getMaximumZoneSize()
public void setMaximumZoneSize(int size)
size
- the number of characters the zone may represent before attempting to break the zone into a smaller size.public int getMaxZonesLoaded()
public void setMaxZonesLoaded(int mzl)
IllegalArgumentException
if mzl
is less than 1.mzl
- the desired maximum number of zones to be actively loaded, must be greater than 0IllegalArgumentException
- if mzl
is < 1protected void zoneWasLoaded(View zone)
zone
- the child view that was just loaded.protected void unloadZone(View zone)
zone
- the child view desired to be set to an unloaded state.protected boolean isZoneLoaded(View zone)
zone
- the zoneprotected View createZone(int p0, int p1)
p0
- the start of the desired zone. This should be >= getStartOffset() and < getEndOffset(). This value should also be < p1.p1
- the end of the desired zone. This should be > getStartOffset() and <= getEndOffset(). This value should also be > p0.protected void loadChildren(ViewFactory f)
setParent
method. This is reimplemented to not load any children directly (as they are created by the zones). This method creates the initial set of zones. Zones don't actually get populated however until an attempt is made to display them or to do model/view coordinate translation.loadChildren
in class CompositeView
f
- the view factoryprotected int getViewIndexAtPosition(int pos)
getViewIndexAtPosition
in class CompositeView
pos
- the position >= 0protected boolean updateChildren(DocumentEvent.ElementChange ec, DocumentEvent e, ViewFactory f)
updateChildren
in class View
ec
- the change information for the element this view is responsible for. This should not be null
if this method gets callede
- the change information from the associated documentf
- the factory to use to build child viewspublic void insertUpdate(DocumentEvent changes, Shape a, ViewFactory f)
insertUpdate
in class View
changes
- the change information from the associated documenta
- the current allocation of the viewf
- the factory to use to rebuild if the view has childrenpublic void removeUpdate(DocumentEvent changes, Shape a, ViewFactory f)
removeUpdate
in class View
changes
- the change information from the associated documenta
- the current allocation of the viewf
- the factory to use to rebuild if the view has children
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/swing/text/ZoneView.html