inputEx Documentation Back to homepage

### inputEx Documentation > inputEx.RTEField 0.2.2

## Static Class inputEx.RTEField - extends inputEx.Field

Wrapper for the Rich Text Editor from YUI

### Constructor

inputEx.RTEField `( options )`

Parameters:
  `options <Object>` - Added options:
  - opts: the options to be added when calling the RTE constructor (see YUI RTE)
  - type: if == 'simple', the field will use the SimpleEditor. Any other value will use the Editor class.

### Properties

#### static groupOptions `- Object`

group Options for each field

#### options `- Object`

Configuration object to set the options for this class and the parent classes. See constructor details for options added by this class.

### Methods

#### getValue

`<String> getValue()`
Get the html string
Returns:

`<String>` the html string

#### renderComponent

`renderComponent()`
Render the field using the YUI Editor widget

#### setOptions

`setOptions(options)`
Set the default values of the options
Parameters:

`options <Object>` - Options object (inputEx inputParams) as passed to the constructor

#### setValue

`setValue(value[,sendUpdatedEvt])`
Set the html content
Parameters:

`value <String>` - The html string

`sendUpdatedEvt <boolean>` optional - (optional) Wether this setValue should fire the updatedEvt or not (default is true, pass false to NOT send the event)

#### Methods inherited from class inputEx.Field:

`focus, getEl, validate, fireUpdatedEvt, show, close, onBlur, onFocus, getStateString, setClassFromState, disable, onChange, render, updatedEvt, initEvents, getState, hide, displayMessage, destroy, isEmpty, enable, clear,`

Copyright (c) 2007-2009 Eric Abouaf. All rights reserved.
Generated by JsDoc Toolkit 2.0.0 on Wed, 04 Mar 2009 15:41:31 GMT using neyricjslibs-template.