Carry out the actual removal of a Component. Implementation dependent on the type of container.
true if the Component was successfully removed, false otherwise.
Creates additional elements as necessary for the Component to function. Called during anchor() if the Component's element has not been created yet. Override in subclasses to provide additional functionality.
Adds a given CSS class to the Component.
The CSS class to add.
Gets the Selection containing the
Will return undefined if the Component has not been anchored.
background selection for the Component
for the component in pixel space, where the topLeft represents the component's minimum x and y values and the bottomRight represents the component's maximum x and y values.
Computes and sets the size, position, and alignment of the Component from the specified values. If no parameters are supplied and the Component is a root node, they are inferred from the size of the Component's element.
Gets a Selection containing a
Will return undefined if the Component has not been anchored.
content selection for the Component
Destroys the ComponentContainer and all Components within it.
Detaches a Component from the DOM. The Component can be reused.
This should only be used if you plan on reusing the calling Component. Otherwise, use destroy().
Checks if the Component has a fixed height or if it grows to fill available space. Returns false by default on the base Component class.
Checks if the Component has a fixed width or if it grows to fill available space. Returns false by default on the base Component class.
Gets the Selection containing the
Will return undefined if the Component has not been anchored.
Checks whether the specified Component is in the ComponentContainer.
Checks if the Component has a given CSS class.
The CSS class to check for.
Gets the height of the Component in pixels.
Removes a callback that would be called on anchoring the Component to the DOM. The callback is identified by reference equality.
Removes a callback to be called when the Component is detach()-ed. The callback is identified by reference equality.
Adds a callback to be called on anchoring the Component to the DOM. If the Component is already anchored, the callback is called immediately.
Adds a callback to be called when the Component is detach()-ed.
Sets a callback that gets called when the component resizes. The size change is not guaranteed to be reflected by the DOM at the time the callback is fired.
Gets the origin of the Component relative to its parent.
Gets the origin of the Component relative to the root
Gets the parent ComponentContainer for this Component.
Sets the parent ComponentContainer for this Component. An error will be thrown if the parent does not contain this Component. Adding a Component to a ComponentContainer should be done using the appropriate method on the ComponentContainer.
Causes the Component to re-layout and render.
This function should be called when a CSS change has occured that could influence the layout of the Component, such as changing the font size.
Removes the specified Component from the ComponentContainer.
Removes a given CSS class from the Component.
The CSS class to remove.
Renders the Component without waiting for the next frame.
Renders the Component to a given
A selector-string for the
Given available space in pixels, returns the minimum width and height this Component will need.
Gets the width of the Component in pixels.
Gets the x alignment of the Component.
Sets the x alignment of the Component.
The x alignment of the Component ("left"/"center"/"right").
Gets the y alignment of the Component.
Sets the y alignment of the Component.
The y alignment of the Component ("top"/"center"/"bottom").
Generated using TypeDoc
Invokes a callback on each Component in the ComponentContainer.