bbbfly-cjs

Index Files Packages Globals

bbbfly. Renderer object

bbbfly.Renderer

helpers/renderer.js, line 773

Properties

Name Type Default Description
StatePropPattern string '[o]?[h]?[D]?[R]?[I]?[S|G]?' State property name pattern
StatePropPattern_Any string '(.*)' Any pattern root
StatePropPattern_Pos string '[L|T]' Position pattern root
StateMap object Value state dependancy map

In Packages

Type Definitions

frame object

Properties:
Name Type Description
LeftTop bbbfly.Renderer.image
RightTop bbbfly.Renderer.image
LeftBottom bbbfly.Renderer.image
RightBottom bbbfly.Renderer.image
Left bbbfly.Renderer.image
Top bbbfly.Renderer.image
Right bbbfly.Renderer.image
Bottom bbbfly.Renderer.image
Center bbbfly.Renderer.image

frameproxy object

Frame image properties for certain state
Properties:
Name Type Description
Id string | undefined optional Frame ID
L bbbfly.Renderer.imageproxy optional Left image properties
T bbbfly.Renderer.imageproxy optional Top image properties
R bbbfly.Renderer.imageproxy optional Right image properties
B bbbfly.Renderer.imageproxy optional Bottom image properties
LT bbbfly.Renderer.imageproxy optional LeftTop image properties
RT bbbfly.Renderer.imageproxy optional RightTop image properties
LB bbbfly.Renderer.imageproxy optional LeftBottom image properties
RB bbbfly.Renderer.imageproxy optional RightBottom image properties
C bbbfly.Renderer.imageproxy optional Center image properties

image object

Properties:
Name Type Description
...L bbbfly.Renderer.statepos
...T bbbfly.Renderer.statepos
W px
H px
Src url
Anchor pos

imageproxy object

Image properties for certain state
Properties:
Name Type Description
Img bbbfly.Renderer.image optional Full image definition
Visible boolean optional If display image
Id string | undefined optional Image ID
Src url | undefined optional Image source url
W px | undefined optional Image width
H px | undefined optional Image height
Anchor pos optional Image reference point
L px optional Image cutout left position
T px optional Image cutout top position
oL px optional Mouse-over image cutout left position
oT px optional Mouse-over image cutout top position

pos object

Properties:
Name Type Description
L px
T px

stackproxy object

Images stack properties for certain state
Properties:
Name Type Description
Id string | undefined optional Stack ID
Imgs Array.<bbbfly.Renderer.imageproxy> Image properties
Anchor pos optional Stack reference point
W px optional Stack width
H px optional Stack height

state object

Properties:
Name Type Description
mouseover boolean
highlight boolean
disabled boolean
readonly boolean
invalid boolean
selected boolean
grayed boolean

statepos px

Implements

statevalues object

Object containing values for different states.
Properties:
Name Type Description
... bbbfly.Renderer.stateval Any number of valid values

style object

Object containing CSS property name - value pairs.

Interfaces

Members

static overflow enum string

Name Type Default Description
hidden string hidden
visible string visible
scroll string scroll
auto string auto

static stateattr enum string

Name Type Default Description
mouseover string o
highlight string h
disabled string D
readonly string R
invalid string I
selected string S
grayed string G

Methods

ActiveFrameHTML (proxy, state, className, id){string}

helpers/renderer.js, line 1059
Parameters:
Name Type Description
proxy bbbfly.Renderer.frameproxy optional
state bbbfly.Renderer.state optional Frame images state
className string optional Frame images className
id string optional Force frame ID
Returns:
Type Description
string Frame images Html

ContainsState (propName, state){boolean}

helpers/renderer.js, line 869
Checks if image property fits state.
Parameters:
Name Type Description
propName string
state bbbfly.Renderer.state
Returns:
Type Description
boolean

DynamicFrameHTML (proxy, state, className, innerHtml, id){string}

helpers/renderer.js, line 1071
Parameters:
Name Type Description
proxy bbbfly.Renderer.frameproxy optional
state bbbfly.Renderer.state optional Frame images state
className string optional Frame images className
innerHtml string optional Frame innerHtml
id string optional Force frame ID
Returns:
Type Description
string Frame images Html

FrameHTML (proxy, state, className, id){string}

helpers/renderer.js, line 1047
Parameters:
Name Type Description
proxy bbbfly.Renderer.frameproxy optional
state bbbfly.Renderer.state optional Frame images state
className string optional Frame images className
id string optional Force frame ID
Returns:
Type Description
string Frame images Html

FrameProxy (frame, state, id){bbbfly.Renderer.frameproxy}

helpers/renderer.js, line 961
Parameters:
Name Type Description
frame bbbfly.Renderer.frame optional Frame definition
state bbbfly.Renderer.state optional Frame images state
id string optional Frame images ID
Returns:
Type Description
bbbfly.Renderer.frameproxy

GetStatePropName (state, nameRoot){string}

helpers/renderer.js, line 835
Checks if image property fits state.
Parameters:
Name Type Description
state bbbfly.Renderer.state
nameRoot string
Returns:
Type Description
string

GetStateValue (value, state, nameRoot){void}

helpers/renderer.js, line 857
Checks if image property fits state.
Parameters:
Name Type Default Description
value bbbfly.Renderer.statevalues | void
state bbbfly.Renderer.state
nameRoot string '' optional Property name root
Returns:
Type Description
void

ImageHTML (proxy, left, top, right, bottom, state, className, style, innerHtml, id){string}

helpers/renderer.js, line 1029
Parameters:
Name Type Description
proxy bbbfly.Renderer.imageproxy optional
left px | percentage optional Image left position
top px | percentage optional Image top position
right px | percentage optional Image right position
bottom px | percentage optional Image bottom position
state bbbfly.Renderer.state optional Image state
className string optional Image className
style bbbfly.Renderer.style optional Additional image style
innerHtml string optional Image innerHtml
id string optional Force image ID
Returns:
Type Description
string Image Html

ImageProxy (img, state, id){bbbfly.Renderer.imageproxy}

helpers/renderer.js, line 950
Parameters:
Name Type Description
img bbbfly.Renderer.image optional Image definition
state bbbfly.Renderer.state optional Image state
id string optional Image ID
Returns:
Type Description
bbbfly.Renderer.imageproxy

IsImagePosition (propName){boolean}

helpers/renderer.js, line 880
Checks image position property name.
Parameters:
Name Type Description
propName string
Returns:
Type Description
boolean

IsStateProp (propName, nameRoot){boolean}

helpers/renderer.js, line 846
Checks state property name.
Parameters:
Name Type Description
propName string
nameRoot string optional
Returns:
Type Description
boolean

RecalcFrame (frame)

helpers/renderer.js, line 941
Fills in all frame image states.
Parameters:
Name Type Description
frame bbbfly.Renderer.frame Frame definition

RecalcImage (img)

helpers/renderer.js, line 921
Fills in all image states.
Parameters:
Name Type Description
img bbbfly.Renderer.image Image definition

RecalcImageState (img, state, pos)

helpers/renderer.js, line 930
Modifies in all state positions.
Parameters:
Name Type Description
img bbbfly.Renderer.image Image definition
state bbbfly.Renderer.state State to recalc
pos bbbfly.Renderer.pos State position

RecalcValue (value, nameRoot)

helpers/renderer.js, line 911
Fills in all value states.
Parameters:
Name Type Default Description
value object Value definition
nameRoot string '' optional Property name root

SetImage (proxy, left, top, right, bottom, state, className, style, innerHtml, id){string}

helpers/renderer.js, line 1011
Parameters:
Name Type Description
proxy bbbfly.Renderer.imageproxy optional
left px | percentage optional Image left position
top px | percentage optional Image top position
right px | percentage optional Image right position
bottom px | percentage optional Image bottom position
state bbbfly.Renderer.state optional Image state
className string optional Image className
style bbbfly.Renderer.style optional Additional image style
innerHtml string optional Image innerHtml
id string optional Force image ID
Returns:
Type Description
string Image Html

StackHTML (proxy, state, className, id){string}

helpers/renderer.js, line 1084
Parameters:
Name Type Description
proxy bbbfly.Renderer.stackproxy optional
state bbbfly.Renderer.state optional Stack images state
className string optional Stack images className
id string optional Force stack ID
Returns:
Type Description
string Stack images Html

StackProxy (imgs, state, id){bbbfly.Renderer.stackproxy}

helpers/renderer.js, line 972
Parameters:
Name Type Description
imgs Array.<bbbfly.Renderer.image> optional Image definitions
state bbbfly.Renderer.state optional Stack images state
id string optional Stack images ID
Returns:
Type Description
bbbfly.Renderer.stackproxy

StyleDim (dim, neg){string}

helpers/renderer.js, line 814
Creates valid css dimmension.
Parameters:
Name Type Description
dim integer | string CSS dimmension
neg boolean Negate value
Returns:
Type Description
string

StyleToString (style){string}

helpers/renderer.js, line 825
Converts style definition into CSS style string.
Parameters:
Name Type Description
style bbbfly.Renderer.style optional
Returns:
Type Description
string

UpdateFrameHTML (proxy, state, id)

helpers/renderer.js, line 1106
Parameters:
Name Type Description
proxy bbbfly.Renderer.frameproxy optional
state bbbfly.Renderer.state optional Frame images state
id string optional Force frame ID

UpdateFrameProxy (proxy, state)

helpers/renderer.js, line 993
Parameters:
Name Type Description
proxy bbbfly.Renderer.frameproxy optional
state bbbfly.Renderer.state optional Frame images state

UpdateHTMLOverflow (node, overflowX,, overflowY)

helpers/renderer.js, line 900
Sets html node overflow style.
Parameters:
Name Type Description
node HTMLElement
overflowX, bbbfly.Renderer.overflow
overflowY bbbfly.Renderer.overflow

UpdateHTMLState (node, state)

helpers/renderer.js, line 890
Sets html node state attributes.
Parameters:
Name Type Description
node HTMLElement
state bbbfly.Renderer.state

UpdateImageHTML (proxy, state, id)

helpers/renderer.js, line 1096
Parameters:
Name Type Description
proxy bbbfly.Renderer.imageproxy optional
state bbbfly.Renderer.state optional Image state
id string optional Force image ID

UpdateImageProxy (proxy, state)

helpers/renderer.js, line 983
Recalculate image properties to certain state.
Parameters:
Name Type Description
proxy bbbfly.Renderer.imageproxy optional
state bbbfly.Renderer.state optional Image state

UpdateStackHTML (proxy, state, id)

helpers/renderer.js, line 1116
Parameters:
Name Type Description
proxy bbbfly.Renderer.stackproxy optional
state bbbfly.Renderer.state optional Stack images state
id string optional Force stack ID

UpdateStackProxy (proxy, state)

helpers/renderer.js, line 1002
Parameters:
Name Type Description
proxy bbbfly.Renderer.stackproxy optional
state bbbfly.Renderer.state optional Frame images state