Class: Font

Constructor

new Font(familyopt, sizeopt, boldopt, italicopt, variantopt)

Font constructor

Parameters:

Name	Type	Attributes	Default
`family`	string	<optional>	'Arial'
`size`	number	<optional>	17
`bold`	number	<optional>	0
`italic`	number	<optional>	0
`variant`	string	<optional>	''

Source: AWT.js, line 41

Members

bold :number

The font bold value

Type:

number

Source: AWT.js, line 362

family :string

The font-family property

Type:

string

Source: AWT.js, line 351

italic :number

The font italic value

Type:

number

Source: AWT.js, line 367

size :number

The font size
Warning: Do not change size directly. Use setSize() instead.

Type:

number

Source: AWT.js, line 356

variant :string

The font variant value

Type:

string

Source: AWT.js, line 372

(static) ALREADY_CALCULATED_FONTS

Array of font objects with already calculated heights

Source: AWT.js, line 308

(static) ALREADY_LOADED_FONTS

Array of font names already loaded from Google Fonts, or generic names provided by browsers by default
See: https://developer.mozilla.org/en-US/docs/Web/CSS/font-family

Source: AWT.js, line 313

(static) GOOGLEFONTS

Google Fonts currently used in substitutions

Source: AWT.js, line 346

(static) SUBSTITUTIONS

Google Fonts equivalent for special fonts used in some JClic projects.
More substitutions can be added to the list for specific projects indicating a
fontSubstitutions object in the data-options attribute of the HTML div element
containing the player.
For example:
<div class ="JClic" data-project="demo.jclic" data-options='{"fontSubstitutions":{"arial":"Arimo"}}'/>

Source: AWT.js, line 323

Methods

_calcHeight() → {module:AWT.Font}

The TextMetrics object used
by CanvasRenderingContext2D
does not provide a heigth value for rendered text.
This stackoverflow question
has an excellent response by Daniel Earwicker explaining how to measure the
vertical dimension of rendered text using a span element.
The code has been slighty adapted to deal with Font objects.

Warning: Do not call this method direcly. Use getHeight() or getMetrics() instead

Source: AWT.js, line 272

Returns:

Type:: module:AWT.Font

cssFont() → {string}

Gets the codification of this font in a single string, suitable to be used in a font
CSS attribute.

Source: AWT.js, line 255

Returns:

A string with all the CSS font properties concatenated

Type:: string

equals(font) → {boolean}

Checks if two Font objects are equivalent

Parameters:

Name	Type	Description
`font`	module:AWT.Font	The Font object to compare against this one

Source: AWT.js, line 296

Returns:

true if both objects are equivalent, false otherwise

Type:: boolean

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: AWT.js, line 166

Returns:

The resulting object, with minimal attrributes

Type:: object

getHeight() → {number}

Calculates the font metrics and returns its height

Source: AWT.js, line 225

Returns:

The font height

Type:: number

getMetrics() → {Object}

Calculates the font metrics

Source: AWT.js, line 205

Returns:

The font metrics

Type:: Object

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

Reads the properties of this Font from a data object

Parameters:

Name	Type	Description
`data`	object	The data object to be parsed

Source: AWT.js, line 175

Returns:

Type:: module:AWT.Font

setProperties($xml) → {module:AWT.Font}

Reads the properties of this Font from an XML element

Parameters:

Name	Type	Description
`$xml`	external:jQuery	The xml element to be parsed

Source: AWT.js, line 146

Returns:

Type:: module:AWT.Font

setSize(size) → {module:AWT.Font}

Allows to change the size member, recalculating the vertical metrics.

Parameters:

Name	Type	Description
`size`	number	The new size to set

Source: AWT.js, line 184

Returns:

Type:: module:AWT.Font

toCss(css) → {object}

Translates the Font properties into CSS statements

Parameters:

Name	Type	Description
`css`	object	The object where to add CSS properties. When null or undefined, a new object will be created and returned.

Source: AWT.js, line 236

Returns:

A set of CSS property-values pairs, ready to be used by JQuery
.css(properties).

Type:: object

zoom(amount) → {module:AWT.Font}

Increases or decreases the current font size by the specified amount

Parameters:

Name	Type	Description
`amount`	number	The amount to increase or decrease current size

Source: AWT.js, line 197

Returns:

Type:: module:AWT.Font

(static) checkTree($tree, optionsopt)

Finds the XML elements with typeface specifications, checks its value against the font
substitution list, replacing the family attribute and loading the alternative font when needed.

Parameters:

Name	Type	Attributes	Description
`$tree`	external:jQuery		The xml element to be processed
`options`	object	<optional>	Optional param that can contain a `fontSubstitutions` attribute with a substition table to be added to `SUBSTITUTIONS`

Source: AWT.js, line 71

(static) loadGoogleFont(name)

Try to load a specific font from [http://www.google.com/fonts]

Parameters:

Name	Type	Description
`name`	string	The font family name

Source: AWT.js, line 125

(static) loadGoogleFonts(fonts)

Try to load a set of Google fonts

Parameters:

Name	Type	Description
`fonts`	Array.<string>	An array of font names

Source: AWT.js, line 136