API Docs for: 1.4.4
Show:

ugsEditorPlus.actions Class

Defined in: editor\ugsEditorPlus.actions.js:1
Module: ugsEditorPlus

Does the work by providing "doAction" method to respond to events (does not attach event handlers); Modifes some page elements -- adjust CSS classes on page, runs Scriptasaurus, etc.

Methods

doAction

(
  • action
  • value
)
private

Defined in editor\ugsEditorPlus.actions.js:71

Executes the requested Action using passed in Value

Parameters:

  • action String

    Action's name; must match one of those defined in the switch below

  • value String

    Value used by Action (OK, a couple methods assume this is boolean/falsy)

doLayout

(
  • value
)
private

Defined in editor\ugsEditorPlus.actions.js:232

Changes positions for Reference Chord Diagrams -- handled entirely via CSS classes

Parameters:

  • value String

    value of the clicked value item

doPlacement

(
  • value
)
Boolean private

Defined in editor\ugsEditorPlus.actions.js:249

Chord Name placement (& "Mini-chord diagrams"). Returns true if Scriptasaurus should be rerun.

Parameters:

  • value String

    value of the clicked value item

Returns:

Boolean:

doSetDiagramSize

(
  • value
)
private

Defined in editor\ugsEditorPlus.actions.js:205

Zooms (scales) chord diagrams

Parameters:

  • value String

    percentage, integer between 0 and, well, 100?; value of the clicked value item

doSetFontSize

(
  • value
)
private

Defined in editor\ugsEditorPlus.actions.js:194

Zooms (scales) fonts

Parameters:

  • value String

    point-size; value of the clicked value item

doSetPageWidth

(
  • value
)
private

Defined in editor\ugsEditorPlus.actions.js:300

(option dialog) changes body class, moving the right page edge

Parameters:

  • value String

    currently selected option value

doSetTheme

(
  • value
)
private

Defined in editor\ugsEditorPlus.actions.js:286

Change the color scheme -- requires changing CSS Class and reruning (to regenerate reference chord diagrams)

Parameters:

  • value String

    value of the clicked value item

doTranspose

(
  • value
)
private

Defined in editor\ugsEditorPlus.actions.js:338

Parses Value to decide number of steps "up" or "down", then fires off transpose

Parameters:

  • value String

    value of the clicked value item

doTuning

(
  • value
)
private

Defined in editor\ugsEditorPlus.actions.js:319

Change the instrument (tuning)

Parameters:

  • value String

    value of the clicked value item

doUpdate

() private

Defined in editor\ugsEditorPlus.actions.js:154

Rerun for new song text; updates UI

init

() public

Defined in editor\ugsEditorPlus.actions.js:47

Sets up this class; modifies form elements; attaches event handlers, etc

resetTranspose

(
  • keyChord
)
private

Defined in editor\ugsEditorPlus.actions.js:408

Sets Transpose menu's selected value to "Original"; adds example chord names

Parameters:

  • keyChord String

run

(
  • isDoBackup
)

Defined in editor\ugsEditorPlus.actions.js:163

Rebuilds song, info, chord diagrams using current settings.

Parameters:

  • isDoBackup Bool

    true forces backup; optional, default false.

setCommonChordsList

(
  • chordList
)
Void private

Defined in editor\ugsEditorPlus.actions.js:470

the list of common chords has been change; update UGS setting

Parameters:

  • chordList Mixed

    Either string, as comma seperated values list, or array of chord names

Returns:

Void:

setEnclosureVisible

(
  • isVisible
)
private

Defined in editor\ugsEditorPlus.actions.js:440

(option dialog) change whether to show/hide the bracket characters

Parameters:

  • isVisible Bool

setIgnoreCommon

(
  • isIgnore
)
private

Defined in editor\ugsEditorPlus.actions.js:460

"Ignore Common" was checked, need to update master chord diagrams

Parameters:

  • isIgnore Bool

setSortAlphabetical

(
  • isAlphabetical
)
private

Defined in editor\ugsEditorPlus.actions.js:450

(option dialog) change whether reference diagrams are sorted alphabetically or by their "song order"

Parameters:

  • isAlphabetical Bool

transpose

(
  • steps
)

Defined in editor\ugsEditorPlus.actions.js:350

Rebuilds song as "run", but first transposes chords

Parameters:

  • steps Int

    number of semitones, +/-6

Properties

_ele

JSON private

Defined in editor\ugsEditorPlus.actions.js:18

associative array/JSON handles to key/frequently accessed DOM Elements (see init()

_prevValues

JSON

Defined in editor\ugsEditorPlus.actions.js:36

associative array/JSON of last click value used; intended to be used to prevent rerunning more expensize operations unnecessailry (when the value didn't actually change)

_public

JsonObject public

Defined in editor\ugsEditorPlus.actions.js:10

attach public members to this object