API: inputEx inputEx.RTEField (YUI Library)

Class inputEx.RTEField - extends inputEx.Field

Wrapper for the Rich Text Editor from YUI

Constructor

inputEx.RTEField

Parameters:

options
                                                    <Object>

Added options:

opts: the options to be added when calling the RTE constructor (see YUI RTE)
editorType: if == 'simple', the field will use the SimpleEditor. Any other value will use the Editor class.

Properties inherited from inputEx.Field:


                                    
                                        
                                        options

Methods

filter_msword


                                        
                                        
                                        
                                        String
                                            filter_msword
                                           (
                                                
                                                        
                                                         value
                                                    
                                                
                                            )

Filters out msword html comments, classes, and other junk (complementary with YAHOO.widget.SimpleEditor.prototype.filter_msword, when filterWord option is true)

Parameters:: value <String> The html string

Returns: String: The html string

getValue

Get the html string

Returns: String: the html string

renderComponent


                                        
                                        
                                        
                                        void
                                            renderComponent
                                           (
                                            )

Render the field using the YUI Editor widget

setOptions

Set the default values of the options

Parameters:: options <Object> Options object as passed to the constructor

setValue


                                        
                                        
                                        
                                        void
                                            setValue
                                           (
                                                
                                                        
                                                         value
                                                    
                                                
                                                        , 
                                                         [sendUpdatedEvt]
                                                    
                                                
                                            )

Set the html content

Parameters:: value <String> The html string; [sendUpdatedEvt] <boolean> (optional) Wether this setValue should fire the updatedEvt or not (default is true, pass false to NOT send the event)

Methods inherited from inputEx.Field:


                                                                                    
                                            clear,
                                            
                                                                                    
                                            close,
                                            
                                                                                    
                                            destroy,
                                            
                                                                                    
                                            disable,
                                            
                                                                                    
                                            displayMessage,
                                            
                                                                                    
                                            enable,
                                            
                                                                                    
                                            fireUpdatedEvt,
                                            
                                                                                    
                                            focus,
                                            
                                                                                    
                                            getEl,
                                            
                                                                                    
                                            getParentField,
                                            
                                                                                    
                                            getState,
                                            
                                                                                    
                                            getStateString,
                                            
                                                                                    
                                            getValue,
                                            
                                                                                    
                                            hide,
                                            
                                                                                    
                                            initEvents,
                                            
                                                                                    
                                            isDisabled,
                                            
                                                                                    
                                            isEmpty,
                                            
                                                                                    
                                            onBlur,
                                            
                                                                                    
                                            onChange,
                                            
                                                                                    
                                            onFocus,
                                            
                                                                                    
                                            render,
                                            
                                                                                    
                                            renderComponent,
                                            
                                                                                    
                                            setClassFromState,
                                            
                                                                                    
                                            setFieldName,
                                            
                                                                                    
                                            setOptions,
                                            
                                                                                    
                                            setParentField,
                                            
                                                                                    
                                            setValue,
                                            
                                                                                    
                                            show,
                                            
                                                                                    
                                            validate

Events inherited from inputEx.Field:


                                        
                                        updatedEvt,

inputEx-library

inputEx 0.7.1

Class inputEx.RTEField - extends inputEx.Field

Constructor

Properties inherited from inputEx.Field:

Methods

filter_msword

getValue

renderComponent

setOptions

setValue

Methods inherited from inputEx.Field:

Events inherited from inputEx.Field:

Modules

Classes

Files

Methods