boxes/BoxBag. BoxBag

DOM element used to display this cell content in wai-aria contexts

An external JQuery DOM element hosted by this box

Flag indicating that $accessibleElement should be always active

Text to be used in accessible contexts

Whether this box must be displayed with alternative or regular color and font settings

An optional box used as a background by this BoxBag

Whether this box has a border or not

The BoxBase related to this AbstractBox. When null, the parent can provide an
alternative one.

The array of cells

The Container to which this AbstractBox belongs

The Dimension of the Rectangle

Whether this box holds the input focus

Whether this box is active or inactive

Whether this box must be displayed with inverted or regular colors

Whether this box is marked (selected) or not

The parent AbstractBox (can be null)

The current position of the shape

Rectangle containing the preferred bounds of the BoxBag

Describes the main role of this box on the activity. Useful in wai-aria descriptions.

The shape of this box (the box Rectangle or a special Shape, if set)

Whether this box has a shape that is not a rectangle

Used to temporary hide a box while other drawing operations are done

Cells with this attribute will be transparent but with painted border

Shape type id

Whether this box is visible or not

Adds the boundaries of another shape to the current one

Adds an AbstractBox to the collection of cells

Returns the index of a specific box in the cells array

Creates a clipping region on the specified HTML canvas 2D rendering context

Clones this Rectangle

Count the number of cells of this BoxBag that are in "inactive" state

Draws the box border

Finisher method

Checks if two shapes are equivalent.

Fills the Shape with the current style in the provided HTML canvas context

Finds the first visible AbstractBox located under the specified point

Gets a object with the basic attributes needed to rebuild this instance excluding functions,
parent references, constants and also attributes retaining the default value.
The resulting object is commonly usued to serialize elements in JSON format.

Gets the background box

Returns the enclosing Rectangle of this box including its border (if any)

Gets the enclosing Rectangle of this Shape.

Returns the box at a specific index in the cells array

Gets the real BoxBase associated to this box, scanning down parent relationships.

Gets the container associated to this box, asking its parents when null.

Gets the container attribute of this box, without checking its parent

Gets a string with the co-ordinates of the upper-left and lower-right vertexs of this rectangle,
(with values rounded to int)

Gets the current $hostedComponent member

Gets the minimum size requested by this BoxBag

Returns the number of cells stored in this BoxBag

Gets the module:AWT.Point corresponding to the lower-right vertex of the Rectangle.

Gets the current parent of this box

Gets the preferred size of this BoxBag

Scales the current size of this box bag, multiplying all values by a specific factor

Gets the current shape used in this box

Expands the boundaries of this shape. This affects the current position and dimension.

Checks if this box has border

Checks if the provided Rectangle r intersects with this shape.

Invalidates the zone corresponding to this box in the associated module:AWT.Container, if any.

Checks if this box is in alternative state.

Checks if this box has the input focus

Checks if this box is currently inactive.

Checks if this box is in inverted state.

Checks if this box is marked

Shorthand method for determining if a Shape is an Rectangle

Checks if this box is temporary hidden

Checks if this box is fully visible

Sets a new location to this box. In JClic this method was named translate.

Sets a new location for this box. In JClic this method was named setLocation

Prepares an HTML canvas 2D rendering context with a path that can be used to stroke a line,
to fill a surface or to define a clipping region.

Recalculates the total size of this BoxBag (useful after direct additions o deletions of
elements in the cells array).
Updates preferredBounds and the current position and size of the box bag.

Multiplies the dimension of the Shape by the specified delta amount.

Overrides module:boxes/AbstractBox.AbstractBox#setAlternative iterating over all the cells stored in this box bag.

Reads the properties of this Rectangle from a data object

Sets the background box

Overrides module:boxes/AbstractBox.AbstractBox#setBorder iterating over all the cells stored in this box bag.

Sets the BoxBase of this box

Sets the specified key - value pair to all cells of this bag.

Setter method for container

Sets or unsets the input focus to this box.

Sets the $hostedComponent member.

Sets the $hostedComponent border, based on the current
BoxBase of this box.

Places and resizes $hostedComponent, based on the size
and position of this box.

Sets $hostedComponent colors and other css properties
based on the current BoxBase of this box.

Makes module:boxes/AbstractBox.AbstractBox#$hostedComponent visible or invisible, based on the value of
the AbstractBox visible flag.

Makes this box active (false) or inactive (true)

Puts this box in inverted mode or restores its original state.

Sets this box in marked mode, or restores its original state.

Setter method for parent

Sets the shape used to draw the content of this box

Changes the size of this box

Makes this box temporary hidden (newVal true) or resets its original state (newVal false)

Overrides module:boxes/AbstractBox.AbstractBox#setVisible iterating over all the cells stored in this box bag.

Draws this shape in the provided HTML canvas 2D rendering context.

Overwrites the original 'Object.toString' method with a more descriptive text

Performs graphics operations for each cell.
Overrides module:boxes/AbstractBox.AbstractBox#update

Here is where classes derived from AbstractBox should implement the drawing of its
content. Background and border are already painted in module:boxes/AbstractBox.AbstractBox#update.

Static method that sets the position and dimension of two Resizable objects based on a
preferred maximum size, a layout schema and a margin.

Static method that sets the position and dimension of a Resizable object based on a
preferred maximum dimension and a margin.