Documentation

Namespace: SSViews

SSViews

Collection of app.SSView objects

Source:

Members

<private, static, constant> _MAX_VIEWS :int

Max number of views

Type:
  • int
Source:

<private, static, nullable> _pages :Element

The neon-animated-pages

Type:
  • Element
Source:

<private, static> _type :int

The view type

Type:
  • int
Source:

<private, static, constant> _views :Array.<app.SSView>

The array of views

Type:
Source:

<static, readonly> Type :int

Enum for view type

Type:
  • int
Source:

Methods

<private, static> _setViewType()

Process settings related to the photo's appearance

Source:

<static> create(t)

Create the app.SSView pages

Parameters:
Name Type Description
t app.Screensaver.Template
Source:

<static> findLoadedPhoto(idx) → {int}

Try to find a photo that has finished loading

Parameters:
Name Type Description
idx int

index into _views
Source:
Returns:

index into _views, -1 if none are loaded

Type
int

<static> get(idx) → {app.SSView}

Get the app.SSView at the given index

Parameters:
Name Type Description
idx int

The index
Source:
Returns:
Type
app.SSView

<static> getCount() → {int}

Get number of views

Source:
Returns:
Type
int

<static> getSelectedIndex() → {int|undefined}

Get the selected index

Source:
Returns:

The index

Type
int | undefined

<static> getType() → {app.SSViews.Type}

Get the type of view

Source:
Returns:
Type
app.SSViews.Type

<static> hasPhoto(photo) → {boolean}

Is the given app.SSPhoto in one of the _views

Parameters:
Name Type Description
photo app.SSPhoto
Source:
Returns:

true if in _views

Type
boolean

<static> hasUsable() → {boolean}

Do we have a view with a usable photo

Source:
Returns:

true if at least one photo is valid

Type
boolean

<static> isSelectedIndex(idx) → {boolean}

Is the given idx the selected index

Parameters:
Name Type Description
idx int

index into app.SSViews
Source:
Returns:

true if selected

Type
boolean

<static> replaceAll()

Replace all views

Source:

<static> setSelectedIndex(selected)

Set the selected index

Parameters:
Name Type Description
selected int
Source: