ProjectSettings

Source: ProjectSettings.js:50

This class contains miscellaneous settings of JClic projects.

In addition to the members of this class, there can be other properties in JClic project files
that are not currently loaded:

• iconFileName
• descriptors
• area
• level
• locale
• authors
• organizations
• revisions

Constructor

ProjectSettings constructor

Parameters

• project (module:project/JClicProject.JClicProject) — The project to which this settings belongs

Instance Methods

setProperties($xml: external:jQuery)

Reads the ProjectSettings values from a JQuery XML element

Parameters

• $xml (external:jQuery) — The XML element to parse

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.

Returns

• object

setAttributes( data: object, ): module:project/ProjectSettings.ProjectSettings

Reads the properties of this ProjectSettings from a data object

Parameters

• data (object) — The data object to be parsed, or just the text content

Returns

• module:project/ProjectSettings.ProjectSettings

Instance Fields

project: module:project/JClicProject.JClicProject

The JClicProject to which this ProjectSettings belongs

title: string

The project title

authors: Array.<object>

The authors of this project.
Each author is represented by an object with the following attributes:
name (mandatory), mail, rol, organization and url

organizations: Array.<object>

Schools, companies and other institutions involved on this project.
Each organization is represented by an object with the following attributes:
name (mandatory), mail, url, address, pc, city, state, country, comments

revisions: Array.<object>

The history of revisions made to this project.
Revisions are represented by objects with the following attributes:
date (mandatory), description, comments and author

description: object

Project's description, maybe in multiple languages.

languages: Array.<string>

JClic projects can use more than one language, so use a string array

locales: Array.<string>

Array of canonical locales, as defined in
Intl

skinFileName: string

The name of an optional 'skin' (visual aspect) can be set for the whole project, or for each Activity

eventSounds: module:media/EventSounds.EventSounds

The main EventSounds object of the project