HTML5 Viewer SDK API Documentation 

Namespaces


Class Index

Classes in s7sdk.common

Class s7sdk.common.TwoStateButton


Extends s7sdk.common.Button.

The TwoStateButton base class manages the core logic and behavior for the various two state button sub-classes that are provided with the SDK. It is an abstract base class that should not be instantiated directly.

Class Summary
Constructor Attributes Constructor Name and Description
 
s7sdk.common.TwoStateButton(id, pid, w, h, css, disableswitch, settings)
Method Summary
Method Attributes Method Name and Description
 
Returns true if the button is selected.
 
setCSS(classname, property, value)
Sets a particular CSS class and property on a component
 
Changes the selected state of the button.
Methods borrowed from class s7sdk.common.Button:
activate, addEventListener, blur, deactivate, dispose, focus, getHeight, getWidth, resize, setLabel
Class Detail
s7sdk.common.TwoStateButton(id, pid, w, h, css, disableswitch, settings)
Parameters:
{String} id
An optional parameter that specifies the ID of the components DOM element
{String} pid
The ID of the parent DOM element to which the component is added as a child.
{int} w
Width in pixels.
{int} h
Height in pixels.
{String} css
CSS class for button.
{Boolean} disableswitch
disabled auto change state on click.
{s7sdk.ParameterManager} settings
A parameter manager instance that represents the desired configuration.
See:
s7sdk.common.PlayPauseButton
s7sdk.common.FullScreenButton
s7sdk.common.ScrubberSwatchesButton
s7sdk.common.ThumbnailPageButton
Method Detail
{Boolean} isSelected()
Returns true if the button is selected.
Returns:
current selection state

setCSS(classname, property, value)
Sets a particular CSS class and property on a component
Parameters:
{String} classname
The CSS classname to use for this style. i.e. .s7playpausebutton
{String} property
The CSS property that is being set. i.e. background-color
{String} value
The CSS property value being set. i.e. #FF0000

setSelected(val)
Changes the selected state of the button.
Parameters:
{Boolean} val
new selection state

Documentation generated by JsDoc Toolkit 2.4.0 on Thu Oct 15 2020 11:59:11 GMT-0000 (UTC)