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

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
From class javax.swing.text.CompositeView
From class javax.swing.text.View
From class java.lang.Object

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:

  1. 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.
  2. forwardUpdate is called to forward the DocumentEvent to the appropriate child views.
  3. 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.