activities/puzzles/HolePuzzle. HolePuzzlePanel

The ActivityPanel where HolePuzzle activities are played

Constructor

new HolePuzzlePanel(act, ps, $divopt)

HolePuzzlePanel constructor

Parameters:
NameTypeAttributesDescription
actmodule:Activity.Activity

The Activity to which this Panel belongs

psmodule:JClicPlayer.JClicPlayer

Any object implementing the methods defined in the
PlayStation Java interface.

$divexternal:jQuery<optional>

The jQuery DOM element where this Panel will deploy

Source

Extends

Members

$animatedBg :external:jQuery

Background element (currently a span) used to place animated GIFs when needed

Type:
Overrides
Source

$animatedBgB :external:jQuery

Additional background element for animated GIFs, used in associations

Type:
Overrides
Source

$canvas :external:jQuery

The jQuery main canvas element used by this panel

Type:
Overrides
Source

$div :external:jQuery

The jQuery div element used by this panel

Type:
Overrides
Source

accessibleCanvas :boolean

Always true, since canvas hit regions have been deprecated!
See: https://developer.mozilla.org/en-US/docs/Web/API/Canvas_API/Tutorial/Hit_regions_and_accessibility

Type:
  • boolean
Overrides
Source

act :module:Activity.Activity

The Activity this panel is related to

Type:
Overrides
Source

bc :module:boxes/BoxConnector.BoxConnector

The object used to connect cells and other elements in some types of activity

Type:
Overrides
Source

bg :module:boxes/ActiveBoxBag.ActiveBoxBag

The ActiveBoxBag object containing the information to be displayed in the panel.

Type:
Source

bgImage :external:HTMLImageElement

The realized image used as a background

Type:
Overrides
Source

currentItem :number

Currently selected item. Used in some types of activities.

Type:
  • number
Overrides
Source

dim :module:AWT.Dimension

The Dimension of the Rectangle

Type:
Overrides
Source

events :Array.<string>

List of mouse, touch and keyboard events intercepted by this panel

Type:
  • Array.<string>
Overrides
Source

firstRun :boolean

true if the activity is running for first time (not due to a click on the replay button)

Type:
  • boolean
Overrides
Source

hiddenBox :module:boxes/ActiveBox.ActiveBox

The hidden cell

Type:
Source

hiddenBoxIndex :number

Index of the hidden cell on the ActiveBagContent

Type:
  • number
Source

invalidatedRect :module:AWT.Rectangle

The currently "invalidated" area

Type:
Overrides
Source

minimumSize :module:AWT.Dimension

The minimum size of this kind of ActivityPanel

Type:
Overrides
Source

parkBg :module:boxes/ActiveBoxGrid.ActiveBoxGrid

An auxiliary box bag with only one box, used to store the "missing piece" of
the puzzle.

Type:
Source

playing :boolean

true while the activity is playing

Type:
  • boolean
Overrides
Source

pos :module:AWT.Point

The current position of the shape

Type:
Overrides
Source

preferredSize :module:AWT.Dimension

The preferred size of this kind of ActivityPanel

Type:
Overrides
Source

ps :module:JClicPlayer.JClicPlayer

The PlayStation used to realize media objects and communicate with the player services
(usually a JClicPlayer

Type:
Overrides
Source

skin :module:skins/Skin.Skin

The realized current Skin

Type:
Overrides
Source

solved :boolean

true when the activity is solved, false otherwise

Type:
  • boolean
Overrides
Source

type :string

Shape type id

Type:
  • string
Overrides
Source

Methods

activityReady()

Called by JClicPlayer when this activity panel is fully visible, just after the
initialization process.

Overrides
Source

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

attachEvent($obj, evt)

Attaches a single event to the specified object

Parameters:
NameTypeDescription
$objexternal:jQuery

The object to which the event will be attached

evtstring

The event name

Overrides
Source

attachEvents()

Attaches the events specified in the events member to the $div member

Overrides
Source

buildAccessibleComponents()

Builds the accessible components needed for this ActivityPanel
This method is called when all main elements are placed and visible, when the activity is ready
to start or when resized.

Overrides
Source

buildVisualComponents()

Prepares the visual components of the activity

Overrides
Source

clear()

Miscellaneous cleaning operations

Overrides
Source

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}

Checks if the provided module:AWT.Point is inside this shape.

Parameters:
NameTypeDescription
_pmodule:AWT.Point

The point to check

Overrides
Source
Returns:
Type: 
boolean

enableCounters(eTime, eScore, eActions)

Enables or disables the three counters (time, score and actions)

Parameters:
NameTypeDescription
eTimeboolean

Whether to enable or disable the time counter

eScoreboolean

Whether to enable or disable the score counter

eActionsboolean

Whether to enable or disable the actions counter

Overrides
Source

end()

Ends the activity

Overrides
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

finishActivity(result)

Ordinary ending of the activity, usually called form processEvent

Parameters:
NameTypeDescription
resultboolean

true if the activity was successfully completed, false otherwise

Overrides
Source

fitTo(proposed, bounds)

Fits the panel within the proposed rectangle. The panel can occupy more space, but always
not surpassing the bounds rectangle.

Parameters:
NameTypeDescription
proposedmodule:AWT.Rectangle

The proposed rectangle

boundsmodule:AWT.Rectangle

The maximum allowed bounds

Overrides
Source

forceFinishActivity()

Forces the ending of the activity.

Overrides
Source

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

getBounds() → {module:AWT.Rectangle}

Gets the enclosing Rectangle of this Shape.

Overrides
Source
Returns:
Type: 
module:AWT.Rectangle

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

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

getShape(rect) → {module:AWT.Shape}

Gets a clone of this shape moved to the pos component of the rectangle and scaled
by its dim value.

Parameters:
NameTypeDescription
rectmodule:AWT.Rectangle

The rectangle to be taken as a base for moving and scaling
this shape.

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

initActivity()

Basic initialization procedure

Overrides
Source

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)

Adds the provided rectangle to the invalidated area.

Parameters:
NameTypeDescription
rectmodule:AWT.Rectangle
Overrides
Source

isRect() → {boolean}

Shorthand method for determining if a Shape is an Rectangle

Overrides
Source
Returns:
Type: 
boolean

moveBy(delta) → {module:AWT.Shape}

Shifts the shape a specified amount in horizontal and vertical directions

Parameters:
NameTypeDescription
deltaPoint | Dimension

The amount to shift the Shape

Overrides
Source
Returns:
Type: 
module:AWT.Shape

moveTo(newPos) → {module:AWT.Shape}

Moves this shape to a new position

Parameters:
NameTypeDescription
newPosmodule:AWT.Point

The new position of the shape

Overrides
Source
Returns:
Type: 
module:AWT.Shape

playEvent(event)

Plays the specified event sound

Parameters:
NameTypeDescription
eventstring

The type of event to be performed

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

processEvent(event) → {boolean}

Main handler used to process mouse, touch, keyboard and edit events

Parameters:
NameTypeDescription
eventexternal:Event

The HTML event to be processed

Overrides
Source
Returns:
  • When this event handler returns false, jQuery will stop its
    propagation through the DOM tree. See: http://api.jquery.com/on
Type: 
boolean

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

setAndPlayMsg(msgCode, eventSoundsCodeopt)

Sets the message to be displayed in the skin message box and optionally plays a sound event.

Parameters:
NameTypeAttributesDescription
msgCodestring

Type of message (initial, final, finalError...)

eventSoundsCodestring<optional>

Optional name of the event sound to be played.

Overrides
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

setBounds(rect)

Sets the size and position of this activity panel

Parameters:
NameTypeDescription
rectmodule:AWT.Rectangle
Overrides
Source

setDimension(preferredMaxSize) → {module:AWT.Dimension}

Sets the real dimension of this panel.

Parameters:
NameTypeDescription
preferredMaxSizemodule:AWT.Dimension

The maximum surface available for the activity panel

Overrides
Source
Returns:
Type: 
module:AWT.Dimension

showHelp()

Displays help about the activity

Overrides
Source

shuffle(bg, visible, fitInArea)

Shuffles the contents of the activity

Parameters:
NameTypeDescription
bgArray.<module:boxes/ActiveBoxBag.ActiveBoxBag>

The sets of boxes to be shuffled

visibleboolean

The shuffle process must be animated on the screen (not yet implemented!)

fitInAreaboolean

Shuffled pieces cannot go out of the current area

Overrides
Source

startActivity()

Called when the activity starts playing

Overrides
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()

Updates the invalidated area

Overrides
Source

updateContent(dirtyRegion)

Updates the graphic content of this panel.
This method will be called from module:AWT.Container#update when needed.

Parameters:
NameTypeDescription
dirtyRegionmodule:AWT.Rectangle

Specifies the area to be updated. When null,
it's the whole panel.

Overrides
Source