boxes/AbstractBox. AbstractBox

This abstract class is the base for most graphic components of JClic. It describes an area
(by default an module:AWT.Rectangle) with some special properties that determine how it must
be drawn on screen.

Some types of boxes can act as containers for other boxes, establishing a hierarchy of dependences.

Constructor

(abstract) new AbstractBox(parent, container, boxBase)

AbstractBox constructor

Parameters:
NameTypeDescription
parentmodule:AbstractBox

The AbstractBox to which this one belongs

containermodule:AWT.Container

The container where this box is placed.

boxBasemodule:BoxBase

The object where colors, fonts, border and other graphic properties
of this box are defined.

Source

Extends

Members

$accessibleElement :external:jQuery

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

Type:
Source

$hostedComponent :external:jQuery

An external JQuery DOM element hosted by this box

Type:
Source

accessibleAlwaysActive :boolean

Flag indicating that $accessibleElement should be always active

Type:
  • boolean
Source

accessibleText :string

Text to be used in accessible contexts

Type:
  • string
Source

alternative :boolean

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

Type:
  • boolean
Source

border :boolean

Whether this box has a border or not

Type:
  • boolean
Source

boxBase :module:boxes/BoxBase.BoxBase

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

Type:
Source

container :module:AWT.Container

The Container to which this AbstractBox belongs

Type:
Source

dim :module:AWT.Dimension

The Dimension of the Rectangle

Type:
Overrides
Source

focused :boolean

Whether this box holds the input focus

Type:
  • boolean
Source

inactive :boolean

Whether this box is active or inactive

Type:
  • boolean
Source

inverted :boolean

Whether this box must be displayed with inverted or regular colors

Type:
  • boolean
Source

marked :boolean

Whether this box is marked (selected) or not

Type:
  • boolean
Source

parent :module:boxes/AbstractBox.AbstractBox

The parent AbstractBox (can be null)

Type:
Source

pos :module:AWT.Point

The current position of the shape

Type:
Overrides
Source

role :string

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

Type:
  • string
Source

shape :module:AWT.Shape

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

Type:
Source

specialShape :boolean

Whether this box has a shape that is not a rectangle

Type:
  • boolean
Source

temporaryHidden :boolean

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

Type:
  • boolean
Source

tmpTrans :boolean

Cells with this attribute will be transparent but with painted border

Type:
  • boolean
Source

type :string

Shape type id

Type:
  • string
Overrides
Source

visible :boolean

Whether this box is visible or not

Type:
  • boolean
Source

Methods

add(shape) → {module:AWT.Rectangle}

Adds the boundaries of another shape to the current one

Parameters:
NameTypeDescription
shapemodule:AWT.Shape

The module:AWT.Shape to be added

Overrides
Source
Returns:
Type: 
module:AWT.Rectangle

clip(ctx, fillRuleopt) → {external:CanvasRenderingContext2D}

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

Parameters:
NameTypeAttributesDefaultDescription
ctxexternal:CanvasRenderingContext2D

The rendering context

fillRulestring<optional>
'nonzero'

Can be 'nonzero' (default when not set) or 'evenodd'

Overrides
Source
Returns:
  • The provided rendering context
Type: 
external:CanvasRenderingContext2D

clone() → {module:AWT.Rectangle}

Clones this Rectangle

Overrides
Source
Returns:
Type: 
module:AWT.Rectangle

contains(p) → {boolean}

Check if this box contains the specified point

Parameters:
NameTypeDescription
pmodule:AWT.Point

The point to be checked

Overrides
Source
Returns:
Type: 
boolean

drawBorder(ctx)

Draws the box border

Parameters:
NameTypeDescription
ctxexternal:CanvasRenderingContext2D

The canvas rendering context where the border
will be drawn.

Source

end()

Finisher method

Source

equals(r) → {boolean}

Checks if two shapes are equivalent.

Parameters:
NameTypeDescription
rmodule:AWT.Shape

The Shape to compare against

Overrides
Source
Returns:
Type: 
boolean

fill(ctx, dirtyRegionopt) → {external:CanvasRenderingContext2D}

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

Parameters:
NameTypeAttributesDescription
ctxexternal:CanvasRenderingContext2D

The canvas 2D rendering context where to fill this shape.

dirtyRegionmodule:AWT.Rectangle<optional>

The context region to be updated. Used as clipping
region when drawing.

Overrides
Source
Returns:
  • The provided rendering context
Type: 
external:CanvasRenderingContext2D

getAttributes() → {object}

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.

Overrides
Source
Returns:
  • The resulting object, with minimal attrributes
Type: 
object

getBorderBounds() → {module:AWT.Rectangle}

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

Source
Returns:
Type: 
module:AWT.Rectangle

getBounds() → {module:AWT.Rectangle}

Gets the enclosing Rectangle of this Shape.

Overrides
Source
Returns:
Type: 
module:AWT.Rectangle

getBoxBaseResolve() → {module:boxes/BoxBase.BoxBase}

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

Source
Returns:
Type: 
module:boxes/BoxBase.BoxBase

getContainerResolve() → {module:AWT.Container}

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

Source
Returns:
Type: 
module:AWT.Container

getContainerX() → {module:AWT.Container}

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

Source
Returns:
Type: 
module:AWT.Container

getCoords() → {string}

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

Overrides
Source
Returns:
Type: 
string

getHostedComponent() → {external:jQuery}

Gets the current $hostedComponent member

Source
Returns:
Type: 
external:jQuery

getOppositeVertex() → {module:AWT.Point}

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

Overrides
Source
Returns:
Type: 
module:AWT.Point

getParent() → {module:boxes/AbstractBox.AbstractBox}

Gets the current parent of this box

Source
Returns:
Type: 
module:boxes/AbstractBox.AbstractBox

getShape() → {module:AWT.Shape}

Gets the current shape used in this box

Overrides
Source
Returns:
Type: 
module:AWT.Shape

grow(dx, dy) → {module:AWT.Rectangle}

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

Parameters:
NameTypeDescription
dxnumber

The amount to grow (or decrease) in horizontal direction

dynumber

The amount to grow (or decrease) in vertical direction

Overrides
Source
Returns:
Type: 
module:AWT.Rectangle

hasBorder() → {boolean}

Checks if this box has border

Source
Returns:
Type: 
boolean

intersects(_r) → {boolean}

Checks if the provided Rectangle r intersects with this shape.

Parameters:
NameTypeDescription
_rmodule:AWT.Rectangle
Overrides
Source
Returns:
Type: 
boolean

invalidate(rect)

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

Parameters:
NameTypeDescription
rectmodule:AWT.Rectangle

The rectangle to be invalidated. When null, it's the full
container area.

Source

isAlternative() → {boolean}

Checks if this box is in alternative state.

Source
Returns:
Type: 
boolean

isFocused() → {boolean}

Checks if this box has the input focus

Source
Returns:
Type: 
boolean

isInactive() → {boolean}

Checks if this box is currently inactive.

Source
Returns:
Type: 
boolean

isInverted() → {boolean}

Checks if this box is in inverted state.

Source
Returns:
Type: 
boolean

isMarked() → {boolean}

Checks if this box is marked

Source
Returns:
Type: 
boolean

isRect() → {boolean}

Shorthand method for determining if a Shape is an Rectangle

Overrides
Source
Returns:
Type: 
boolean

isTemporaryHidden() → {boolean}

Checks if this box is temporary hidden

Source
Returns:
Type: 
boolean

isVisible() → {boolean}

Checks if this box is fully visible

Source
Returns:
Type: 
boolean

moveBy(dx, dy)

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

Parameters:
NameTypeDescription
dxnumber

The displacement on the X axis

dynumber

The displacement on the Y axis

Overrides
Source

moveTo(newPos, yopt)

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

Parameters:
NameTypeAttributesDescription
newPosAWT.Point | number

A point or the x coordinate of a new point.

ynumber<optional>

The y coordinate of a new point.

Overrides
Source

preparePath(ctx) → {external:CanvasRenderingContext2D}

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.

Parameters:
NameTypeDescription
ctxexternal:CanvasRenderingContext2D
Overrides
Source
Returns:
  • The provided rendering context
Type: 
external:CanvasRenderingContext2D

scaleBy(delta) → {module:AWT.Rectangle}

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

Parameters:
NameTypeDescription
deltaPoint | Dimension

Object containing the X and Y ratio to be scaled.

Overrides
Source
Returns:
Type: 
module:AWT.Rectangle

setAlternative(newVal)

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

Parameters:
NameTypeDescription
newValboolean
Source

setAttributes(data) → {module:AWT.Rectangle}

Reads the properties of this Rectangle from a data object

Parameters:
NameTypeDescription
dataobject

The data object to be parsed

Overrides
Source
Returns:
Type: 
module:AWT.Rectangle

setBorder(newVal)

Sets/unsets a border to this box

Parameters:
NameTypeDescription
newValboolean

true to set a border.

Source

setBounds(rect, yopt, wopt, hopt) → {module:AWT.Rectangle}

Sets a new size and/or dimension to this box

Parameters:
NameTypeAttributesDescription
rectAWT.Rectangle | number

An AWT.Rectangle object, or the x coordinate of the
upper-left corner of a new rectangle.

ynumber<optional>

y coordinate of the upper-left corner of the new rectangle.

wnumber<optional>

Width of the new rectangle.

hnumber<optional>

Height of the new rectangle.

Overrides
Source
Returns:
Type: 
module:AWT.Rectangle

setBoxBase(boxBase)

Sets the BoxBase of this box

Parameters:
NameTypeDescription
boxBasemodule:boxes/BoxBase.BoxBase

The new BoxBase

Source

setContainer(newContainer)

Setter method for container

Parameters:
NameTypeDescription
newContainermodule:AWT.Container

The new Container assigned to this box

Source

setFocused(newVal)

Sets or unsets the input focus to this box.

Parameters:
NameTypeDescription
newValboolean
Source

setHostedComponent($hc)

Sets the $hostedComponent member.

Parameters:
NameTypeDescription
$hcexternal:jQuery

The jQuery DOM component hosted by this box.

Source

setHostedComponentBorder()

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

Source

setHostedComponentBounds(_sizeChanged)

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

Parameters:
NameTypeDescription
_sizeChangedboolean

true when this ActiveBox has changed its size

Source

setHostedComponentColors()

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

Source

setHostedComponentVisible()

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

Source

setInactive(newVal)

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

Parameters:
NameTypeDescription
newValboolean
Source

setInverted(newVal)

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

Parameters:
NameTypeDescription
newValboolean
Source

setMarked(newVal)

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

Parameters:
NameTypeDescription
newValboolean
Source

setParent(parent)

Setter method for parent

Parameters:
NameTypeDescription
parentmodule:boxes/AbstractBox.AbstractBox

The new parent of this box

Source

setShape(sh)

Sets the shape used to draw the content of this box

Parameters:
NameTypeDescription
shmodule:AWT.Shape

The shape to be set

Source

setSize(width, height)

Changes the size of this box

Parameters:
NameTypeDescription
widthnumber
heightnumber
Source

setTemporaryHidden(newVal)

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

Parameters:
NameTypeDescription
newValboolean
Source

setVisible(newVal)

Sets this box visible or invisible

Parameters:
NameTypeDescription
newValboolean

true for visible

Source

stroke(ctx) → {external:CanvasRenderingContext2D}

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

Parameters:
NameTypeDescription
ctxexternal:CanvasRenderingContext2D

The canvas 2D rendering context where to draw the shape.

Overrides
Source
Returns:
  • The provided rendering context
Type: 
external:CanvasRenderingContext2D

toString() → {string}

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

Overrides
Source
Returns:
Type: 
string

update(ctx, dirtyRegionopt)

Draws the content of this box on an HTML canvas element. At this level, only background
and border are painted/stroked. Derived classes should implement specific drawing tasks in
module:boxes/AbstractBox.AbstractBox#updateContent.

Parameters:
NameTypeAttributesDefaultDescription
ctxexternal:CanvasRenderingContext2D

The canvas rendering context used to draw the
box content.

dirtyRegionmodule:AWT.Rectangle<optional>
null

The area that must be repainted. null refers to the whole box.

Source

updateContent(_ctx, _dirtyRegionopt)

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.

Parameters:
NameTypeAttributesDescription
_ctxexternal:CanvasRenderingContext2D

The canvas rendering context used to draw the
box content.

_dirtyRegionmodule:AWT.Rectangle<optional>

The area that must be repainted. null refers to the whole box.

Source