HTML5 Viewer SDK API Documentation 

Namespaces


Class Index

Classes in s7sdk.model

Class s7sdk.model.SelectorModel

The SelectorModel represents a "simple selector" that can take part in a chain of other SelectorModel instances to form a full selector. In addition the SelectorModel servers to manage an associated collection of CSS property models that manage properties of the parsedCSS.

Class Summary
Constructor Attributes Constructor Name and Description
 
s7sdk.model.SelectorModel(name, component, parentModel, combinator, metadata)
Field Summary
Field Attributes Field Name and Description
<static>  
s7sdk.model.SelectorModel.SEQUENCE
Constants to represent the relationship an selector model has when chained
Method Summary
Method Attributes Method Name and Description
 
addChildNode(simpleSelector)
Return user friendly name of selector
<static>  
s7sdk.model.SelectorModel.applyComponentToChain(component, rootSelectorModel)
Set component instance on this SelectorModel and all descendants
<static>  
s7sdk.model.SelectorModel.applyParsedCssToChain(parsedCss, rootSelectorModel)
Set parsed CSS rule to particular selector model
 
Retrieve metadata object from descriptor
 
Return user friendly name of selector
 
Accessor method for parsed CSS
 
Get the root parent SelectorModel
 
Returns array representing the chain of selector models starting from the root model to all decendant models.
 
Notify all property listeners with current state
 
propertyModelChanged(property, oldValue, newValue)
Listener to respond to property changes in this selector models respective CSSPropertyModel instances.
 
setComponent(component)
Set SDK component instance on this SelectorModel instance
 
Set parsed CSS rule to particular selector model
 
setTip(value)
Set help text to associate with this model
 
toFullSelectorString(withMarkers)
Return the fully qualified string representation (the full CSS selector) for this selector model by concatenating the string representations of all parent selector models
 
Return string represenation of this particular selector model, overridden in sub-class
Class Detail
s7sdk.model.SelectorModel(name, component, parentModel, combinator, metadata)
Parameters:
name
component
parentModel
combinator
metadata
Field Detail
<static> s7sdk.model.SelectorModel.SEQUENCE
Constants to represent the relationship an selector model has when chained
Method Detail
addChildNode(simpleSelector)
Return user friendly name of selector
Parameters:
simpleSelector

<static> s7sdk.model.SelectorModel.applyComponentToChain(component, rootSelectorModel)
Set component instance on this SelectorModel and all descendants
Parameters:
component
rootSelectorModel

<static> s7sdk.model.SelectorModel.applyParsedCssToChain(parsedCss, rootSelectorModel)
Set parsed CSS rule to particular selector model
Parameters:
parsedCss
rootSelectorModel

getMetadata()
Retrieve metadata object from descriptor

getName()
Return user friendly name of selector

getParsedCSS()
Accessor method for parsed CSS

getRootSelectorModel()
Get the root parent SelectorModel

getSelectorChain()
Returns array representing the chain of selector models starting from the root model to all decendant models.

notifyAll()
Notify all property listeners with current state

propertyModelChanged(property, oldValue, newValue)
Listener to respond to property changes in this selector models respective CSSPropertyModel instances. Here we make calls to set CSS on SDK components for preview purposes. We should also consider updating the parsed CSS representation here instead of inside the property models.
Parameters:
property
oldValue
newValue

setComponent(component)
Set SDK component instance on this SelectorModel instance
Parameters:
component

setParsedCSS(rule)
Set parsed CSS rule to particular selector model
Parameters:
rule

setTip(value)
Set help text to associate with this model
Parameters:
value

toFullSelectorString(withMarkers)
Return the fully qualified string representation (the full CSS selector) for this selector model by concatenating the string representations of all parent selector models
Parameters:
withMarkers

toSelectorString()
Return string represenation of this particular selector model, overridden in sub-class

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