SilkPage

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 dentifier.
$page	Object	jQuery object referencing to the page HTML tag.
$content	Object	jQuery object referencing to the page HTML tag.
isSingle	Boolean	Indicates if the page is being display alone.

Methods and Event

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

Returns a SilkPage isntance.

Param	Type	Description
id	String	Unique identifier.
stage	String	The stages 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

getID() ⇒ String

Returns the page's name or unique identifier.

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

getTitle() ⇒ String

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

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

goBack()

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

Kind: instance method of SilkPage

mask(mode)

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

Kind: instance method of SilkPage

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

on(eventName, eventFunction)

Extends the "on" method from the eventManager Class.

Kind: instance method of SilkPage

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

resize()

Executes the resize of pages in reference to the active one.

Kind: instance method of SilkPage

setTitle(title)

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

Kind: instance method of SilkPage

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

show()

Makes a page visible and the active one.

Kind: instance method of SilkPage

on:show

Event triggered when the page becomes active. Created with the SilkPage.on("show", function(){}) method.

Kind: event emitted by SilkPage