Page

The SilkPage Class provides properties, methods, and events to interface with the HTML tags generated by the <silk:Page> tag.

Kind: global class

Properties

Name	Type	Description
id	String	The page's name and unique identifier.
$page	Object	jQuery object referencing the page HTML tag.
$content	Object	jQuery object referencing the page HTML tag.
isSingle	Boolean	Indicates if the page is being displayed alone.

Constructor

new Page(id, stage, width, screenSetup, returnPage, tabsNav)

Returns a Page instance.

Param	Type	Description
id	String	Unique identifier.
stage	String	The stage's code to be used in the layout scheme.
width	Integer	Deprecated.
screenSetup	String	The layout scheme.
returnPage	String	The name of the page to return when clicking the back button.
tabsNav	String	The name of the TabsNav object holding the page

Methods

getID() ⇒ String

Returns the page's name or unique identifier.

Kind: instance method of Page Returns: String - Unique identifier.

getTitle() ⇒ String

Gets the page's title if the page is using a header.

Kind: instance method of Page Returns: String - The page header's title.

getVisible() ⇒ Boolean

Return if the page is visible or not.

Kind: instance method of Page Returns: Boolean - The visible status

goBack()

Returns to the previous linked page, or to the set returned

Kind: instance method of Page

mask(mode)

Executes the page masking. The masking process isolates the page from other pages.

Kind: instance method of Page

Param	Type	Description
mode	boolean	If true, the page is masked; if false, the page is unmasked.

on(eventName, eventFunction)

Load events to respond to the page's interactions. To set an event, use this code: Page.on(<eventName>, function(){<code>}).

Kind: instance method of Page

Param	Type	Description
eventName	String	The event's name.
eventFunction	function	The function to be triggered.

resize()

Executes the resizing of pages referencing the currently active

Kind: instance method of Page

setTitle(title)

Sets the page title if the page is using a header.

Kind: instance method of Page

Param	Type	Description
title	String	The new page header's title.

show()

Makes a page visible and the active one.

Kind: instance method of Page

Events

on:show

The event is triggered when the page becomes active. Created with the Page.on("show", function(){}) method.

Kind: event emitted by Page