Class BoxView

public BoxView(Element element,
               int axis)

Creates a new BoxView for the given Element and axis. Valid values for the axis are View.X_AXIS and View.Y_AXIS.

Parameters:

element - the element that is rendered by this BoxView

axis - the axis along which the box is laid out

protected void baselineLayout(int span,
                              int axis,
                              int[] offsets,
                              int[] spans)

Calculates the baseline layout of the children of this BoxView along the specified axis. This is not used by the BoxView itself, but by subclasses that wish to perform a baseline layout, like the FlowView's rows.

Parameters:

span - the target span

axis - the axis that is examined

offsets - an empty array, filled with the offsets of the children

spans - an empty array, filled with the spans of the children

protected SizeRequirements baselineRequirements(int axis,
                                                SizeRequirements sr)

Calculates size requirements for a baseline layout. This is not used by the BoxView itself, but by subclasses that wish to perform a baseline layout, like the FlowView's rows.

Parameters:

axis - the axis that is examined

sr - the SizeRequirements object to hold the result, if null, a new one is created

Returns:

the size requirements for this BoxView along the specified axis

protected SizeRequirements calculateMajorAxisRequirements(int axis,
                                                          SizeRequirements sr)

Calculates the size requirements of this BoxView along its major axis, that is the axis specified in the constructor.

Parameters:

axis - the axis that is examined

sr - the SizeRequirements object to hold the result, if null, a new one is created

Returns:

the size requirements for this BoxView along the specified axis

protected SizeRequirements calculateMinorAxisRequirements(int axis,
                                                          SizeRequirements sr)

Calculates the size requirements of this BoxView along its minor axis, that is the axis opposite to the axis specified in the constructor.

Parameters:

axis - the axis that is examined

sr - the SizeRequirements object to hold the result, if null, a new one is created

Returns:

the size requirements for this BoxView along the specified axis

protected void childAllocation(int index,
                               Rectangle a)

Computes the allocation for a child View. The parameter a stores the allocation of this CompositeView and is then adjusted to hold the allocation of the child view.

Overrides:

childAllocation in interface CompositeView

Parameters:

index - the index of the child View

a - the allocation of this CompositeView before the call, the allocation of the child on exit

protected boolean flipEastAndWestAtEnds(int position,
                                        Position.Bias bias)

Determines if the next view in horinzontal direction is located to the east or west of the view at position pos. Usually the Views are laid out from the east to the west, so we unconditionally return false here. Subclasses that support bidirectional text may wish to override this method.

Overrides:

flipEastAndWestAtEnds in interface CompositeView

Parameters:

bias - the bias to be applied to pos

Returns:

true if the next View is located to the EAST, false otherwise

protected void forwardUpdate(DocumentEvent.ElementChange ec,
                             DocumentEvent e,
                             Shape a,
                             ViewFactory vf)

Forwards the DocumentEvent to child views that need to get notified of the change to the model. This calles View.forwardUpdateToView(View,DocumentEvent,Shape,ViewFactory) for each View that must be forwarded to. If ec is not null (this means there have been structural changes to the element that this view is responsible for) this method should recognize this and don't notify newly added child views.

Overrides:

forwardUpdate in interface View

Parameters:

ec - the ElementChange describing the element changes (may be null if there were no changes)

vf - the ViewFactory used to create new Views

Since:

1.3

public float getAlignment(int axis)

Returns the alignment for this box view for the specified axis. The axis that is tiled (the major axis) will be requested to be aligned centered (0.5F). The minor axis alignment depends on the child view's total alignment.

Overrides:

getAlignment in interface View

Parameters:

axis - the axis which is examined

Returns:

the alignment for this box view for the specified axis

public int getAxis()

Returns the axis along which this BoxView is laid out.

Returns:

the axis along which this BoxView is laid out

Since:

1.3

public Shape getChildAllocation(int index,
                                Shape a)

Returns the child allocation for the child view with the specified index. If the layout is invalid, this returns null.

Overrides:

getChildAllocation in interface CompositeView

Parameters:

index - the child view index

a - the allocation to this view

Returns:

the child allocation for the child view with the specified index or null if the layout is invalid or a is null

public int getHeight()

Return the current height of the box. This is the last allocated height.

Returns:

the current height of the box

public float getMaximumSpan(int axis)

Returns the maximum span of this view along the specified axis. This returns Integer.MAX_VALUE for the minor axis and the preferred span for the major axis.

Overrides:

getMaximumSpan in interface View

Parameters:

axis - the axis

Returns:

the maximum span of this view along the specified axis

public float getMinimumSpan(int axis)

Returns the minimum span of this view along the specified axis. This calculates the minimum span using calculateMajorAxisRequirements(int,SizeRequirements) or calculateMinorAxisRequirements(int,SizeRequirements) (depending on the axis) and returns the resulting minimum span.

Overrides:

getMinimumSpan in interface View

Parameters:

axis - the axis

Returns:

the minimum span of this view along the specified axis

protected int getOffset(int axis,
                        int childIndex)

Returns the offset for the child view with the given index for the specified axis.

Parameters:

axis - the axis to examine, either X_AXIS or Y_AXIS

childIndex - the index of the child for for which to return the span

Returns:

the offset for the child view with the given index for the specified axis

public float getPreferredSpan(int axis)

Returns the preferred span of the content managed by this View along the specified axis.

Overrides:

getPreferredSpan in interface View

Parameters:

axis - the axis

Returns:

the preferred span of this View.

public int getResizeWeight(int axis)

Returns the resize weight of this view. A value of 0 or less means this view is not resizeable. Positive values make the view resizeable. This implementation returns 0 for the major axis and 1 for the minor axis of this box view.

Overrides:

getResizeWeight in interface View

Parameters:

axis - the axis

Returns:

the resizability of this view along the specified axis

Throws:

IllegalArgumentException - if axis is invalid

protected int getSpan(int axis,
                      int childIndex)

Returns the span for the child view with the given index for the specified axis.

Parameters:

axis - the axis to examine, either X_AXIS or Y_AXIS

childIndex - the index of the child for for which to return the span

Returns:

the span for the child view with the given index for the specified axis

protected View getViewAtPoint(int x,
                              int y,
                              Rectangle r)

Returns the child View at the specified location.

Overrides:

getViewAtPoint in interface CompositeView

Parameters:

x - the X coordinate

y - the Y coordinate

r - the inner allocation of this BoxView on entry, the allocation of the found child on exit

Returns:

the child View at the specified location

public int getWidth()

Return the current width of the box. This is the last allocated width.

Returns:

the current width of the box

protected boolean isAfter(int x,
                          int y,
                          Rectangle r)

Returns true if the specified point lies after the given Rectangle, false otherwise. "After" is typically defined as being to the right or below.

Overrides:

isAfter in interface CompositeView

Parameters:

x - the X coordinate of the point

y - the Y coordinate of the point

r - the rectangle to test the point against

Returns:

true if the specified point lies after the given Rectangle, false otherwise

protected boolean isAllocationValid()

Returns true if the cached allocations for the children are still valid, false otherwise.

Returns:

true if the cached allocations for the children are still valid, false otherwise

protected boolean isBefore(int x,
                           int y,
                           Rectangle r)

Returns true if the specified point lies before the given Rectangle, false otherwise. "Before" is typically defined as being to the left or above.

Overrides:

isBefore in interface CompositeView

Parameters:

x - the X coordinate of the point

y - the Y coordinate of the point

r - the rectangle to test the point against

Returns:

true if the specified point lies before the given Rectangle, false otherwise

protected boolean isLayoutValid(int axis)

Returns true if the layout along the specified axis is valid, false otherwise. Valid values for the axis are View.X_AXIS and View.Y_AXIS.

Parameters:

axis - the axis

Returns:

true if the layout along the specified axis is valid, false otherwise

Since:

1.4

protected void layout(int width,
                      int height)

Lays out the children of this BoxView with the specified bounds.

Parameters:

width - the width of the allocated region for the children (that is the inner allocation of this BoxView

height - the height of the allocated region for the children (that is the inner allocation of this BoxView

public void layoutChanged(int axis)

Marks the layout along the specified axis as invalid. This is triggered automatically when any of the child view changes its preferences via preferenceChanged(View,boolean,boolean). The layout will be updated the next time when setSize(float,float) is called, typically from within the paint(Graphics,Shape) method. Valid values for the axis are View.X_AXIS and View.Y_AXIS.

Parameters:

axis - an int value

Since:

1.3

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

Performs the layout along the major axis of a BoxView.

Parameters:

targetSpan - the (inner) span of the BoxView in which to layout the children

axis - the axis along which the layout is performed

offsets - the array that holds the offsets of the children on exit

spans - the array that holds the spans of the children on exit

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

Performs the layout along the minor axis of a BoxView.

Parameters:

targetSpan - the (inner) span of the BoxView in which to layout the children

axis - the axis along which the layout is performed

offsets - the array that holds the offsets of the children on exit

spans - the array that holds the spans of the children on exit

public Shape modelToView(int pos,
                         Shape a,
                         Position.Bias bias)
            throws BadLocationException

Maps the document model position pos to a Shape in the view coordinate space. This method overrides CompositeView's method to make sure the children are allocated properly before calling the super's behaviour.

Overrides:

modelToView in interface CompositeView

public void paint(Graphics g,
                  Shape a)

Renders the Element that is associated with this View.

Overrides:

paint in interface View

Parameters:

g - the Graphics context to render to

a - the allocated region for the Element

protected void paintChild(Graphics g,
                          Rectangle alloc,
                          int index)

Paints the child View at the specified index. This method modifies the actual values in alloc so make sure you have a copy of the original values if you need them.

Parameters:

g - the Graphics context to paint to

alloc - the allocated region for the child to paint into

index - the index of the child to be painted

See Also:

childAllocation(int,Rectangle)

public void preferenceChanged(View child,
                              boolean width,
                              boolean height)

Called by a child View when its preferred span has changed.

Overrides:

preferenceChanged in interface View

Parameters:

child - the child View.

width - indicates that the preferred width of the child changed.

height - indicates that the preferred height of the child changed.

public void replace(int offset,
                    int length,
                    View[] views)

Replaces child views by some other child views. If there are no views to remove (length == 0), the result is a simple insert, if there are no children to add (view == null) the result is a simple removal. In addition this invalidates the layout and resizes the internal cache for the child allocations. The old children's cached allocations can still be accessed (although they are not guaranteed to be valid), and the new children will have an initial offset and span of 0.

Overrides:

replace in interface CompositeView

Parameters:

offset - the start offset from where to remove children

length - the number of children to remove

views - the views that replace the removed children

public void setAxis(int axis)

Sets the axis along which this BoxView is laid out. Valid values for the axis are View.X_AXIS and View.Y_AXIS.

Parameters:

axis - the axis along which this BoxView is laid out

Since:

1.3

public void setSize(float width,
                    float height)

Sets the size of the view. If the actual size has changed, the layout is updated accordingly.

Overrides:

setSize in interface View

Parameters:

width - the new width

height - the new height

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

Maps coordinates from the View's space into a position in the document model.

Overrides:

viewToModel in interface CompositeView

Parameters:

x - the x coordinate in the view space, x >= 0

y - the y coordinate in the view space, y >= 0

a - the allocation of this View

Returns:

the position in the document that corresponds to the screen coordinates x, y >= 0