Class: tinymce.ui.NativeListBox

# tinymce.ui.NativeListBox

Namespace | tinymce.ui
Class | NativeListBox
Inheritance | NativeListBox ListBox Control

This class is used to create list boxes/select list. This one will generate a native control the way that the browser produces them by default.

## Public Properties

Property | Defined By
--- | ---
items : Array Array of ListBox items. | ListBox

## Public Methods

Method | Defined By
--- | ---
NativeListBox(id:String, s:Object) Constructs a new button control instance. | NativeListBox
add(n:String, v:String, o:Object):void Adds a option item to the list box. | NativeListBox
destroy():void Destroys the ListBox i. | ListBox
getLength():void Executes the specified callback function for the menu item. | NativeListBox
hideMenu():void Hides the drop menu. | ListBox
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. | NativeListBox
isRendered():Boolean Returns true/false if the control has been rendered or not. | Control
postRender():void Post render handler. | NativeListBox
remove():void Removes the control. | Control
renderHTML():String Renders the list box as a HTML string. | NativeListBox
renderMenu():void Renders the menu to the DOM. | ListBox
renderTo(n:Element):void Renders the control to the specified container element. | Control
select(va:String/function):void Selects a item/option by value. | NativeListBox
selectByIndex(idx:String):void Selects a item/option by index. | NativeListBox
setActive(s:Boolean):void Sets the activated state for the control. | Control
setDisabled(s:Boolean):void Sets the disabled state for the control. | NativeListBox
setState(c:String, s:Boolean):void Sets the specified class state for the control. | Control
showMenu():void Displays the drop menu with all items. | ListBox

## Public Events

Event | Defined By
--- | ---
onAdd() Fires when a new item is added. | ListBox
onChange() Fires when the selection has been changed. | ListBox
onPostRender() Fires after the element has been rendered to DOM. | ListBox
onRenderMenu() Fires when the menu gets rendered. | ListBox

## Method details

### NativeListBoxconstructor

`public function NativeListBox(id:String, s:Object)`
Constructs a new button control instance.

#### Parameters

id:String | Button control id for the button.
s:Object | Optional name/value settings object.

### addmethod

`public function add(n:String, v:String, o:Object):void`
Adds a option item to the list box.

#### Parameters

n:String | Title for the new option.
v:String | Value for the new option.
o:Object | Optional object with settings like for example class.

### getLengthmethod

`public function getLength():void`
Executes the specified callback function for the menu item. In this case when the user clicks the menu item.

### isDisabledmethod

`public function isDisabled():Boolean`
Returns true/false if the control is disabled or not. This is a method since you can then choose to check some class or some internal bool state in subclasses.

#### Returns

Boolean - true/false if the control is disabled or not.

### postRendermethod

`public function postRender():void`
Post render handler. This function will be called after the UI has been rendered so that events can be added.

### renderHTMLmethod

`public function renderHTML():String`
Renders the list box as a HTML string. This method is much faster than using the DOM and when creating a whole toolbar with buttons it does make a lot of difference.

#### Returns

String - HTML for the list box control element.

### selectmethod

`public function select(va:String/function):void`
Selects a item/option by value. This will both add a visual selection to the item and change the title of the control to the title of the option.

#### Parameters

va:String/function | Value to look for inside the list box or a function selector.

### selectByIndexmethod

`public function selectByIndex(idx:String):void`
Selects a item/option by index. This will both add a visual selection to the item and change the title of the control to the title of the option.

#### Parameters

idx:String | Index to select, pass -1 to select menu/title of select box.

### setDisabledmethod

`public function setDisabled(s:Boolean):void`
Sets the disabled state for the control. This will add CSS classes to the element that contains the control. So that it can be disabled visually.

#### Parameters

s:Boolean | Boolean state if the control should be disabled or not.