Caplin Trader 5.1.0

Interface: module:br-component/Component

module:br-component/Component

This interface must be implemented by a presentation-level class. A presentation-level class represents something that occupies physical space on the page, such as the content of a panel or a dialog box.

Each implementation of a Component represents a different Component type, for example a Grid or a Trade Panel.

A component receives a Frame, on which it can set its content element and attach event listeners.

Components that can have their state saved should also implement br-component/Serializable.

Methods

setDisplayFrame(frame)

Parameters:
Name Type Description
frame module:br-component/Frame

A frame provided by the layout manager that this component can attach its visual DOM elements into. Will be called only once.