project/JClicProject. JClicProject

JClicProject contains all the components of a JClic project: activities, sequences, media
files, descriptors and metadata.

This encapsulation is achieved by three auxiliary objects:

  • ProjectSettings: stores metadata like full title, description, authors, languages,
    educational topics...
  • ActivitySequence: defines the order in which the activities must be shown.
  • MediaBag: contains the list of all media files used by the activities

Constructor

new JClicProject()

JClicProject constructor

Source

Members

activitySequence :module:bags/ActivitySequence.ActivitySequence

Object containing the order in which the activities should be played

Type:
Source

basePath :string

Relative path or absolute URL to be used as a base to access files, usually in conjunction
with module:JClicPlayer.JClicPlayer#basePath

Type:
  • string
Source

code :string

Optional property that can be used by reporting systems

Type:
  • string
Source

mediaBag :module:bags/MediaBag.MediaBag

The collection of all media elements used in this project

Type:
Source

name :string

The project's name

Type:
  • string
Source

path :string

Full path of this project

Type:
  • string
Source

reportableActs :number

Number of activities suitable to be included reports

Type:
  • number
Source

settings :module:project/ProjectSettings.ProjectSettings

Object containing the project settings

Type:
Source

skin :module:skins/Skin.Skin

The object that builds and manages the visual interface presented to users

Type:
Source

type :string

Optional property that can be used by reporting systems

Type:
  • string
Source

version :string

The version of the XML file format used to save the project (currently 0.1.3)

Type:
  • string
Source

zip :external:JSZip

The JSZip object where this project is stored (can be null)

Type:
Source

Methods

end()

Run finalizers on realized objects

Source

getActivity(name) → {module:Activity.Activity}

Finds activities by name and builds the corresponding Activity object.

Parameters:
NameTypeDescription
namestring

The name of the requested activity

Source
Returns:
Type: 
module:Activity.Activity

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.

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

getJSON(spaceopt) → {string}

Gets a JSON string representing the content of this project. This string can be transformed later into a data
object suitable for setAttributes.

Parameters:
NameTypeAttributesDefaultDescription
spacenumber<optional>
0

The number of white spaces to place between items. Defaults to zero (meaning all the JSON rendered in one single line)

Source
Returns:
  • The JSON text
Type: 
string

realize(ps)

Builds the Skin, EventSounds and MediaBag fonts associated to this project.

Parameters:
NameTypeDescription
psmodule:JClicPlayer.JClicPlayer

The PlayStation (usually a JClicPlayer) linked to this project.

Source

setAttributes(data, path, zipopt, optionsopt) → {module:project/JClicProject.JClicProject}

Loads the project settings from a data object

Parameters:
NameTypeAttributesDescription
dataobject

The data object

pathstring

The full path of this project

zipexternal:JSZip<optional>

An optional JSZip object where this project is encapsulated

optionsobject<optional>

An object with miscellaneous options

Source
Returns:
Type: 
module:project/JClicProject.JClicProject

setProperties($xml, path, zipopt, optionsopt) → {module:project/JClicProject.JClicProject}

Loads the project settings from a main jQuery XML element

Parameters:
NameTypeAttributesDescription
$xmlexternal:jQuery

The XML element

pathstring

The full path of this project

zipexternal:JSZip<optional>

An optional JSZip object where this project is encapsulated

optionsobject<optional>

An object with miscellaneous options

Source
Returns:
Type: 
module:project/JClicProject.JClicProject