0 results found

tinymce.ui.Container

Contribute to this page
Namespace tinymce.ui
Class Container
Inheritance Container Control
Subclasses Toolbar, ToolbarGroup

This class is the base class for all container controls like toolbars. This class should not be instantiated directly other container controls should inherit from this one.

Public Properties

Property Defined By
controls : Array : Array of controls added to the container. Container

Public Methods

Method Defined By
Container(id:String, s:Object) : Base contrustor a new container control instance. Container
add(c:Control):Control : Adds a control to the collection of controls for the container. Container
destroy():void : Destroys the control will free any memory by removing event listeners etc. Control
get(n:String):Control : Returns a control by id from the containers collection. Container
isActive():Boolean : Returns true/false if the control is disabled or not. Control
isDisabled():Boolean : Returns true/false if the control is disabled or not. Control
isRendered():Boolean : Returns true/false if the control has been rendered or not. Control
postRender():void : Post render event. Control
remove():void : Removes the control. Control
renderHTML():String : Renders the control as a HTML string. Control
renderTo(n:Element):void : Renders the control to the specified container element. Control
setActive(s:Boolean):void : Sets the activated state for the control. Control
setDisabled(s:Boolean):void : Sets the disabled state for the control. Control
setState(c:String, s:Boolean):void : Sets the specified class state for the control. Control

Property details

controls

public controls : Array
Array of controls added to the container.

Method details

Container

public function Container(id:String, s:Object)
Base contrustor a new container control instance.

Parameters

Param Detail
id:String Control id to use for the container.
s:Object Optional name/value settings object.

add

public function add(c:Control):Control
Adds a control to the collection of controls for the container.

Parameters

Param Detail
c:Control Control instance to add to the container.

Returns
Control - Same control instance that got passed in.

get

public function get(n:String):Control
Returns a control by id from the containers collection.

Parameters

Param Detail
n:String Id for the control to retrive.

Returns
Control - Control instance by the specified name or undefined if it wasn't found.

Except as otherwise noted, the content of this page is licensed under the Creative Commons BY-NC-SA 3.0 License, and code samples are licensed under the Apache 2.0 License.