- core
- Context
- ElementAllocator
- ElementOutput
- Engine
- Entity
- EventEmitter
- EventHandler
- Group
- Modifier
- OptionsManager
- RenderNode
- Scene
- SpecParser
- Transform
- View
- ViewSequence
- events
- EventArbiter
- EventFilter
- EventMapper
- inputs
- Accumulator
- GenericSync
- MouseSync
- PinchSync
- RotateSync
- ScaleSync
- ScrollSync
- TouchSync
- TouchTracker
- TwoFingerSync
- math
- Matrix
- Quaternion
- Random
- Utilities
- Vector
- modifiers
- Draggable
- Fader
- ModifierChain
- StateModifier
- physics
- PhysicsEngine
- physics/bodies
- Body
- Circle
- Particle
- Rectangle
- physics/constraints
- Surface
- Collision
- Constraint
- Curve
- Distance
- Snap
- Wall
- Walls
- physics/forces
- Drag
- Force
- Repulsion
- RotationalDrag
- RotationalSpring
- Spring
- VectorField
- physics/integrators
- SymplecticEuler
- surfaces
- CanvasSurface
- ContainerSurface
- ImageSurface
- InputSurface
- TextareaSurface
- VideoSurface
- transitions
- CachedMap
- Easing
- MultipleTransition
- SnapTransition
- SpringTransition
- Transitionable
- TransitionableTransform
- TweenTransition
- WallTransition
- utilities
- KeyCodes
- Timer
- Utility
- views
- ContextualView
- Deck
- DrawerLayout
- EdgeSwapper
- FlexibleLayout
- Flipper
- GridLayout
- HeaderFooterLayout
- Lightbox
- RenderController
- ScrollContainer
- Scroller
- Scrollview
- SequentialLayout
- widgets
- NavigationBar
- TabBar
ContainerSurface
ContainerSurface is an object designed to contain surfaces and set properties to be applied to all of them at once. This extends the Surface class. A container surface will enforce these properties on the surfaces it contains: size (clips contained surfaces to its own width and height); origin; its own opacity and transform, which will be automatically applied to all Surfaces contained directly and indirectly.
Overview
Options
Methods
add
ContainerSurface(options.size] [width, height, options.classes, options.properties, options.content)
Constructor Parameters
options.size] [width, height
Array.Number
in pixels
options.classes
Array.string
CSS classes to set on all inner content
options.properties
Array
string dictionary of HTML attributes to set on target div
options.content
String
inner (HTML) content of surface (should not be used)
Methods
add(obj)
Add renderables to this object's render tree
Parameters
obj
Object
renderable object
Returns
RenderNode
RenderNode wrapping this object, if not already a RenderNode
render()Private
Return spec for this surface. Note: Can result in a size recalculation.
Returns
Object
render spec for this surface (spec id)
deploy(target)Private
Place the document element this component manages into the document.
Parameters
target
Node
document parent of this container
commit(context, transform, opacity, origin, size)Private
Apply changes from this component to the corresponding document element. This includes changes to classes, styles, size, content, opacity, origin, and matrix transforms.
Parameters
context
Context
commit context
transform
Transform
unused TODO
opacity
Number
unused TODO
origin
Array.Number
unused TODO
size
Array.Number
unused TODO
Returns
Undefined
TODO returns an undefined value