HTML5 Viewer SDK API Documentation 

Namespaces


Class Index

Classes in s7sdk.model

Class s7sdk.model.CSSPropertyModel


Extends s7sdk.Observable.
Base CSSProperty model class.

Class Summary
Constructor Attributes Constructor Name and Description
 
s7sdk.model.CSSPropertyModel(selectorModel, config, metadata)
Method Summary
Method Attributes Method Name and Description
 
connectWidget(widget)
Connect widget to PropertyModel, and listen to all relavent properties
 
createProperty(property, defaultValues, css, exists)
Base class implementation to handle property instantiation
 
createWidget(factory)
A convinience method to create a widget that corresponds to the model widget (CSSPropertyModel).
 
Disconnect widget from PropertyModel, removing all property listeners
<static>  
s7sdk.model.CSSPropertyModel.EquivalentResolver(propName, cssPropObj)
Leverage browser to determine which CSS properties are equivalent, for example when 'border: 1px solid red;' is set, 'red' will be returned when 'border-color' is queried.
 
Base class property declaration, here for correctness
 
Initialize properties by iterating over propertyDeclaration
 
Notify all property listeners with current state
 
propertyChangeListener(property, oldValue, newValue)
A callback function to be passed to addPropertyListener() Make sure the addPropertyListener() is called with a bind so when this listener is called "this" refers to this instance
 
readCSS(property, onlyCascaded)
Return resolved CSS property value from parsed CSS.
 
readRetinaCSS(property, onlyCascaded)
Return CSS property value for retina rule, if it exists
 
removeFromCSS(property)
Remove property from parsed CSS object
 
setProperty(property, config)
Clone, set and notify updated property using provided config object.
Methods borrowed from class s7sdk.Observable:
addPropertyListener, addPropertyListeners, notifyPropertyChanged, removePropertyListener, removePropertyListeners
Class Detail
s7sdk.model.CSSPropertyModel(selectorModel, config, metadata)
Parameters:
selectorModel
config
metadata
See:
s7sdk.model.CSSPositionModel
s7sdk.model.CSSSizeModel
s7sdk.model.CSSTextModel
Method Detail
connectWidget(widget)
Connect widget to PropertyModel, and listen to all relavent properties
Parameters:
widget

createProperty(property, defaultValues, css, exists)
Base class implementation to handle property instantiation
Parameters:
property
defaultValues
css
exists

createWidget(factory)
A convinience method to create a widget that corresponds to the model widget (CSSPropertyModel).
Parameters:
factory

disconnectWidget()
Disconnect widget from PropertyModel, removing all property listeners

<static> s7sdk.model.CSSPropertyModel.EquivalentResolver(propName, cssPropObj)
Leverage browser to determine which CSS properties are equivalent, for example when 'border: 1px solid red;' is set, 'red' will be returned when 'border-color' is queried.
Parameters:
propName
cssPropObj

getPropertyDeclaration()
Base class property declaration, here for correctness

initProperties()
Initialize properties by iterating over propertyDeclaration

notifyAll()
Notify all property listeners with current state

propertyChangeListener(property, oldValue, newValue)
A callback function to be passed to addPropertyListener() Make sure the addPropertyListener() is called with a bind so when this listener is called "this" refers to this instance
Parameters:
property
oldValue
newValue

readCSS(property, onlyCascaded)
Return resolved CSS property value from parsed CSS. This includes properties whos values have been cascaded from more general rules. If 'onlyCascaded' is true, then then only cascaded property values are returned.
Parameters:
property
onlyCascaded

readRetinaCSS(property, onlyCascaded)
Return CSS property value for retina rule, if it exists
Parameters:
property
onlyCascaded

removeFromCSS(property)
Remove property from parsed CSS object
Parameters:
property

setProperty(property, config)
Clone, set and notify updated property using provided config object.
Parameters:
property
config

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