public class

BlockView

extends BoxView

java.lang.Object
↳	javax.swing.text.View
	↳	javax.swing.text.CompositeView
		↳	javax.swing.text.BoxView
			↳	javax.swing.text.html.BlockView

Known Direct Subclasses

ListView

Class Overview

A view implementation to display a block (as a box) with CSS specifications.

Summary

[Expand]

Inherited Constants

From class javax.swing.text.View

From interface javax.swing.SwingConstants

Public Constructors
	BlockView(Element elem, int axis) Creates a new view that represents an html box.

Public Methods
void	changedUpdate(DocumentEvent changes, Shape a, ViewFactory f) Gives notification from the document that attributes were changed in a location that this view is responsible for.
float	getAlignment(int axis) Gets the alignment.
AttributeSet	getAttributes() Fetches the attributes to use when 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.
float	getPreferredSpan(int axis) Determines the preferred span for this view along an axis.
int	getResizeWeight(int axis) Gets the resize weight.
void	paint(Graphics g, Shape allocation) Renders using the given rendering surface and area on that surface.
void	setParent(View parent) Establishes the parent view for this view.

Protected Methods
SizeRequirements	calculateMajorAxisRequirements(int axis, SizeRequirements r) Calculate the requirements of the block along the major axis (i.e.
SizeRequirements	calculateMinorAxisRequirements(int axis, SizeRequirements r) Calculate the requirements of the block along the minor axis (i.e.
StyleSheet	getStyleSheet()
void	layoutMinorAxis(int targetSpan, int axis, int[] offsets, int[] spans) Performs layout for the minor axis of the box (i.e.
void	setPropertiesFromAttributes() Update any cached values that come from attributes.

[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 BlockView (Element elem, int axis)

Creates a new view that represents an html box. This can be used for a number of elements.

Parameters

elem	the element to create a view for
axis	either View.X_AXIS or View.Y_AXIS

Public Methods

public void changedUpdate (DocumentEvent changes, Shape a, ViewFactory f)

Gives notification from the document that attributes were changed in a location that this view is responsible for. To reduce the burden to subclasses, this functionality is spread out into the following calls that subclasses can reimplement:

updateChildren is called if there were any changes to the element this view is responsible for. If this view has child views that are represent the child elements, then this method should do whatever is necessary to make sure the child views correctly represent the model.
forwardUpdate is called to forward the DocumentEvent to the appropriate child views.
updateLayout is called to give the view a chance to either repair its layout, to reschedule layout, or do nothing.

Parameters

changes	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

public float getAlignment (int axis)

Gets the alignment.

Parameters

axis	may be either X_AXIS or Y_AXIS

Returns

the alignment

public AttributeSet getAttributes ()

Fetches the attributes to use when rendering. This is implemented to multiplex the attributes specified in the model with a StyleSheet.

public float getMaximumSpan (int axis)

Determines the maximum span for this view along an axis.

Parameters

axis	may be either `View.X_AXIS` or `View.Y_AXIS`

Returns

the span the view would like to be rendered into >= 0; typically the view is told to render into the span that is returned, although there is no guarantee; the parent may choose to resize or break the view

Throws

IllegalArgumentException	for an invalid axis type

public float getMinimumSpan (int axis)

Determines the minimum span for this view along an axis.

Parameters

axis	may be either `View.X_AXIS` or `View.Y_AXIS`

Returns

the span the view would like to be rendered into >= 0; typically the view is told to render into the span that is returned, although there is no guarantee; the parent may choose to resize or break the view

Throws

IllegalArgumentException	for an invalid axis type

public float getPreferredSpan (int axis)

Determines the preferred span for this view along an axis.

Parameters

axis	may be either `View.X_AXIS` or `View.Y_AXIS`

Returns

the span the view would like to be rendered into >= 0; typically the view is told to render into the span that is returned, although there is no guarantee; the parent may choose to resize or break the view

Throws

IllegalArgumentException	for an invalid axis type

public int getResizeWeight (int axis)

Gets the resize weight.

Parameters

axis	may be either X_AXIS or Y_AXIS

Returns

the weight

Throws

IllegalArgumentException	for an invalid axis

public void paint (Graphics g, Shape allocation)

Renders using the given rendering surface and area on that surface. This is implemented to delegate to the css box painter to paint the border and background prior to the interior.

Parameters

g	the rendering surface to use
allocation	the allocated region to render into

public void setParent (View parent)

Establishes the parent view for this view. This is guaranteed to be called before any other methods if the parent view is functioning properly.

This is implemented to forward to the superclass as well as call the setPropertiesFromAttributes() method to set the paragraph properties from the css attributes. The call is made at this time to ensure the ability to resolve upward through the parents view attributes.

Parameters

parent	the new parent, or null if the view is being removed from a parent it was previously added to

Protected Methods

protected SizeRequirements calculateMajorAxisRequirements (int axis, SizeRequirements r)

Calculate the requirements of the block along the major axis (i.e. the axis along with it tiles). This is implemented to provide the superclass behavior and then adjust it if the CSS width or height attribute is specified and applicable to the axis.

Parameters

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

Returns

the newly initialized SizeRequirements object

protected SizeRequirements calculateMinorAxisRequirements (int axis, SizeRequirements r)

Calculate the requirements of the block along the minor axis (i.e. the axis orthoginal to the axis along with it tiles). This is implemented to provide the superclass behavior and then adjust it if the CSS width or height attribute is specified and applicable to the axis.

Parameters

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

Returns

the newly initialized SizeRequirements object

protected StyleSheet getStyleSheet ()

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

Performs layout for the minor axis of the box (i.e. the axis orthoginal to the axis that it represents). The results of the layout (the offset and span for each children) are placed in the given arrays which represent the allocations to the children along the minor axis.

Parameters

targetSpan	the total span given to the view, which whould be used to layout the childre.
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

protected void setPropertiesFromAttributes ()

Update any cached values that come from attributes.

Classes

Enums

BlockView

Class Overview

Summary

Public Constructors

public BlockView (Element elem, int axis)

Parameters

Public Methods

public void changedUpdate (DocumentEvent changes, Shape a, ViewFactory f)

Parameters

public float getAlignment (int axis)

Parameters

Returns

public AttributeSet getAttributes ()

public float getMaximumSpan (int axis)

Parameters

Returns

Throws

public float getMinimumSpan (int axis)

Parameters

Returns

Throws

public float getPreferredSpan (int axis)

Parameters

Returns

Throws

public int getResizeWeight (int axis)

Parameters

Returns

Throws

public void paint (Graphics g, Shape allocation)

Parameters

See Also

public void setParent (View parent)

Parameters

Protected Methods

protected SizeRequirements calculateMajorAxisRequirements (int axis, SizeRequirements r)

Parameters

Returns

protected SizeRequirements calculateMinorAxisRequirements (int axis, SizeRequirements r)

Parameters

Returns

protected StyleSheet getStyleSheet ()

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

Parameters

protected void setPropertiesFromAttributes ()