API Docs for: 0.0.2
Show:

layout.Factory Class

Defined in: api/src/layout/factory.js:1
Module: language

Factory class for layout managers

Methods

getCountCards

() Number

Defined in api/src/layout/card.js:303

Return number of cards in deck

Returns:

Number: count cards

getIndexOfVisibleCard

() Number

Defined in api/src/layout/card.js:311

Return index of visible card

Returns:

Number: card index

getLayoutClass

(
  • view
)
String private

Defined in api/src/layout/factory.js:18

Returns correct name of layout class

Parameters:

  • view ludo.View

Returns:

String: className

getManager

(
  • view
)
ludo.layout.Base

Defined in api/src/layout/factory.js:8

Returns layout manager, a layout.Base or subclass

Parameters:

  • view ludo.View

Returns:

ludo.layout.Base: manager

getMergedLayout

(
  • layout
  • mergeWith
)
Object private

Defined in api/src/layout/factory.js:126

Returned merged layout object, i.e. layout defind on HTML page merged with internal layout defined in class

Parameters:

Returns:

Object:

getPercentCompleted

() Number

Defined in api/src/layout/card.js:337

Returns percentage position of current visible card.

Returns:

Number: percent

getPreviousCardOf

(
  • view
)

Defined in api/src/layout/card.js:66

Return reference to previus card of passed card

Parameters:

Returns:

View

getValidLayoutObject

(
  • view
  • config
)
Object private

Defined in api/src/layout/factory.js:61

Returns valid layout configuration for a view

Parameters:

  • view ludo.View
  • config Object

Returns:

Object:

isFirstCard

(
  • card
)
Boolean

Defined in api/src/layout/card.js:159

Return true if passed card is first card in deck

Parameters:

Returns:

Boolean:

isLastCard

(
  • card
)

Defined in api/src/layout/card.js:150

Return true if passed card is last card in deck

Parameters:

Returns:

Boolean

isOnFirstCard

() Boolean

Defined in api/src/layout/card.js:320

true if first card in deck is shown.

Returns:

Boolean: is on first card

isOnLastCard

() Boolean

Defined in api/src/layout/card.js:328

true if last card in deck is shown.

Returns:

Boolean: is on last card

isValid

() Boolean public

Defined in api/src/layout/card.js:291

Returns true if form of current card is valid

Returns:

Boolean:

showCard

(
  • name
)
Boolean

Defined in api/src/layout/card.js:137

Show a card with this name

Parameters:

Returns:

Boolean: success

showFirstCard

()

Defined in api/src/layout/card.js:267

Show first card in deck

Returns:

void

showLastCard

()

Defined in api/src/layout/card.js:275

Show last card in deck

Returns:

void

showNextCard

(
  • skipAnimation
)
Boolean

Defined in api/src/layout/card.js:102

Show next card of current visible card

Parameters:

Returns:

Boolean: success

showPreviousCard

(
  • skipAnimation
)
Boolean

Defined in api/src/layout/card.js:82

Show previous card of current visible card

Parameters:

Returns:

Boolean: success

Events

firstcard

Defined in api\src\layout\card.js:228

Event fired when first card of deck is shown

Event Payload:

  • this layout.Card

    card

  • shown View

    card

highercard

Defined in api\src\layout\card.js:185

Event fired when a higher card than current is shown

Event Payload:

  • this layout.Card

    deck

  • shown View

    card

lastcard

Defined in api\src\layout\card.js:211

Event fired when last card of deck is shown

Event Payload:

  • this layout.Card

    card

  • shown View

    card

lowercard

Defined in api\src\layout\card.js:193

Event fired when a lower card than current is shown

Event Payload:

  • this layout.Card

    deck

  • shown View

    card

notfirstcard

Defined in api\src\layout\card.js:237

Event fired when a card which is not the first card in the deck is shown

Event Payload:

  • this layout.Card

    card

  • shown View

    card

notlastcard

Defined in api\src\layout\card.js:219

Event fired when na card which is not the last card in the deck is shown

Event Payload:

  • this layout.Card

    card

  • shown View

    card

showcard

Defined in api\src\layout\card.js:202

Event fired when a card is shown

Event Payload:

  • this layout.Card

    deck

  • shown View

    card