Class: Footer

js-whatever/js/footer. Footer

View representing a page footer which can have multiple tabs and be minimised. The state of the footer is
stored in local storage

Parameters:
Name Type Description
options FooterOptions
Source:

Extends

  • Backbone.View

Members

className :string

Classes added to footer element

Type:
  • string
Source:

events

Backbone events hash

Source:

expanded :string

Local storage key for if the footer is expanded

Type:
  • string
Source:

index :string

Local storage key for the current tab index

Type:
  • string
Source:

processors :Array.<FooterProcessor>

Defines the components of the footer

Type:
  • Array.<FooterProcessor>
Source:

Methods

handleTabClick(e)

Event handler called when a tab is clicked

Parameters:
Name Type Description
e object

jQuery event

Source:

hide()

Hides the footer

Source:

render()

Renders the footer according to the defined processors and tabData

Source:

selectIndex(index)

Select a footer tab by index

Parameters:
Name Type Description
index Number

The index of the tab in tabData

Source:

show()

Shows the footer

Source:

toggle()

Toggles the footer

Source:

updateForState(state)

Shows or hides the footer.

Parameters:
Name Type Description
state boolean

True to show the footer, false to hide the footer

Source:
Copyright 2013-2018 Micro Focus International plc. Licensed under the MIT License (the "License"); you may not use this file except in compliance with the License.
Documentation generated by JSDoc 3.4.3 on Thu Jun 21st 18:04 2018 using the DocStrap template.