|
addEvents( Object object ) : void |
Observable |
Used to define events on this Observable |
|
addListener( String eventName , Function handler , [Object scope ], [Object options ] ) : void |
Observable |
Appends an event handler to this component |
|
applyTo( String/HTMLElement/Element el ) : Ext.form.Field |
Field |
Apply the behaviors of this component to an existing element. This is used instead of render(). |
|
cleanHtml( String html ) : void |
HtmlEditor |
Protected method that will not generally be called directly. If you need/want
custom HTML cleanup, this is the method... |
|
createToolbar( HtmlEditor editor ) : void |
HtmlEditor |
Protected method that will not generally be called directly. It
is called when the editor creates its toolbar. Overri... |
|
destroy() : void |
Component |
Destroys this component by purging any event listeners, removing the component's element from the DOM,
removing the c... |
|
disable() : Ext.Component |
Component |
Disable this component. |
|
enable() : Ext.Component |
Component |
Enable this component. |
|
execCmd( String cmd , [String/Boolean value ] ) : void |
HtmlEditor |
Executes a Midas editor command directly on the editor document.
For visual commands, you should use relayCmd instead... |
|
fireEvent( String eventName , Object... args ) : Boolean |
Observable |
Fires the specified event with the passed parameters (minus the event name). |
|
focus( Boolean selectText ) : Ext.Component |
Component |
Try to focus this component. |
|
getBox( [Boolean local ] ) : s |
BoxComponent |
Gets the current box measurements of the component's underlying element. |
|
getDocMarkup() : void |
HtmlEditor |
Protected method that will not generally be called directly. It
is called when the editor initializes the iframe with... |
|
getEl() : Ext.Element |
Component |
Returns the underlying Ext.Element. |
|
getId() : String |
Component |
Returns the id of this component. |
|
getName() : String |
Field |
Returns the name attribute of the field if available |
|
getPosition( [Boolean local ] ) : Array |
BoxComponent |
Gets the current XY position of the component's underlying element. |
|
getRawValue() : Mixed |
Field |
Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see getValue. |
|
getSize() : Object |
BoxComponent |
Gets the current size of the component's underlying element. |
|
getToolbar() : Ext.Toolbar |
HtmlEditor |
Returns the editor's toolbar. This is only available after the editor has been rendered. |
|
getValue() : Mixed |
Field |
Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see getRa... |
|
hasListener( String eventName ) : Boolean |
Observable |
Checks to see if this object has any listeners for a specified event |
|
hide() : Ext.Component |
Component |
Hide this component. |
|
insertAtCursor( String text ) : void |
HtmlEditor |
Inserts the passed text at the current cursor position. Note: the editor must be initialized and activated
to insert ... |
|
isDirty() : void |
Field |
Returns true if this field has been changed since it was originally loaded and is not disabled. |
|
isValid( Boolean preventMark ) : Boolean |
Field |
Returns whether or not the field value is currently valid |
|
isVisible() : void |
Component |
Returns true if this component is visible. |
|
on( String eventName , Function handler , [Object scope ], [Object options ] ) : void |
Observable |
Appends an event handler to this element (shorthand for addListener) |
|
onPosition( Number x , Number y ) : void |
BoxComponent |
Called after the component is moved, this method is empty by default but can be implemented by any
subclass that need... |
|
onResize( Number adjWidth , Number adjHeight , Number rawWidth , Number rawHeight ) : void |
BoxComponent |
Called after the component is resized, this method is empty by default but can be implemented by any
subclass that ne... |
|
purgeListeners() : void |
Observable |
Removes all listeners for this object |
|
pushValue() : void |
HtmlEditor |
Protected method that will not generally be called directly. Pushes the value of the textarea
into the iframe editor. |
|
relayCmd( String cmd , [String/Boolean value ] ) : void |
HtmlEditor |
Executes a Midas editor command on the editor document and performs necessary focus and
toolbar updates. This should ... |
|
removeListener( String eventName , Function handler , [Object scope ] ) : void |
Observable |
Removes a listener |
|
render( [String/HTMLElement/Element container ] ) : void |
Component |
If this is a lazy rendering component, render it to its container element. |
|
reset() : void |
Field |
Resets the current field value to the originally loaded value and clears any validation messages |
|
setDisabled( Boolean disabled ) : void |
Component |
Convenience function for setting disabled/enabled by boolean. |
|
setPagePosition( Number x , Number y ) : s |
BoxComponent |
Sets the page XY position of the component. To set the left and top instead, use setPosition.
This method fires the ... |
|
setPosition( Number left , Number top ) : s |
BoxComponent |
Sets the left and top of the component. To set the page XY position instead, use setPagePosition.
This method fires ... |
|
setRawValue( Mixed value ) : void |
Field |
Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see setValue. |
|
setSize( Number/Object width , Number height ) : Ext.BoxComponent |
BoxComponent |
Sets the width and height of the component. This method fires the resize event. This method can accept
either width... |
|
setValue( Mixed value ) : void |
Field |
Sets a data value into the field and validates it. To set the value directly without validation see setRawValue. |
|
setVisible( Boolean visible ) : Ext.Component |
Component |
Convenience function to hide or show this component by boolean. |
|
show() : Ext.Component |
Component |
Show this component. |
|
syncSize() : s |
BoxComponent |
Force the component's size to recalculate based on the underlying element's current height and width. |
|
syncValue() : void |
HtmlEditor |
Protected method that will not generally be called directly. Syncs the contents
of the editor iframe with the textarea. |
|
toggleSourceEdit( [Boolean sourceEdit ] ) : void |
HtmlEditor |
Toggles the editor between standard and source edit mode. |
|
un( String eventName , Function handler , [Object scope ] ) : void |
Observable |
Removes a listener (shorthand for removeListener) |
|
updateBox( Object box ) : s |
BoxComponent |
Sets the current box measurements of the component's underlying element. |
|
updateToolbar() : void |
HtmlEditor |
Protected method that will not generally be called directly. It triggers
a toolbar update by reading the markup state... |
|
validate() : Boolean |
Field |
Validates the field value |
|
activate : ( HtmlEditor this ) |
HtmlEditor |
Fires when the editor is first receives the focus. Any insertion must wait
until after this event. |
|
beforedestroy : ( Ext.Component this ) |
Component |
Fires before the component is destroyed. Return false to stop the destroy. |
|
beforehide : ( Ext.Component this ) |
Component |
Fires before the component is hidden. Return false to stop the hide. |
|
beforepush : ( HtmlEditor this , String html ) |
HtmlEditor |
Fires before the iframe editor is updated with content from the textarea. Return false
to cancel the push. |
|
beforerender : ( Ext.Component this ) |
Component |
Fires before the component is rendered. Return false to stop the render. |
|
beforeshow : ( Ext.Component this ) |
Component |
Fires before the component is shown. Return false to stop the show. |
|
beforesync : ( HtmlEditor this , String html ) |
HtmlEditor |
Fires before the textarea is updated with content from the editor iframe. Return false
to cancel the sync. |
|
destroy : ( Ext.Component this ) |
Component |
Fires after the component is destroyed. |
|
disable : ( Ext.Component this ) |
Component |
Fires after the component is disabled. |
|
editmodechange : ( HtmlEditor this , Boolean sourceEdit ) |
HtmlEditor |
Fires when the editor switches edit modes |
|
enable : ( Ext.Component this ) |
Component |
Fires after the component is enabled. |
|
hide : ( Ext.Component this ) |
Component |
Fires after the component is hidden. |
|
initialize : ( HtmlEditor this ) |
HtmlEditor |
Fires when the editor is fully initialized (including the iframe) |
|
invalid : ( Ext.form.Field this , String msg ) |
Field |
Fires after the field has been marked as invalid. |
|
move : ( Ext.Component this , Number x , Number y ) |
BoxComponent |
Fires after the component is moved. |
|
push : ( HtmlEditor this , String html ) |
HtmlEditor |
Fires when the iframe editor is updated with content from the textarea. |
|
render : ( Ext.Component this ) |
Component |
Fires after the component is rendered. |
|
resize : ( Ext.Component this , Number adjWidth , Number adjHeight , Number rawWidth , Number rawHeight ) |
BoxComponent |
Fires after the component is resized. |
|
show : ( Ext.Component this ) |
Component |
Fires after the component is shown. |
|
sync : ( HtmlEditor this , String html ) |
HtmlEditor |
Fires when the textarea is updated with content from the editor iframe. |
|
valid : ( Ext.form.Field this ) |
Field |
Fires after the field has been validated with no errors. |
|
allowDomMove : Boolean |
Component |
Whether the component can move the Dom node when rendering (defaults to true). |
|
cls : String |
Field |
A CSS class to apply to the field's underlying element. |
|
createLinkText : String |
HtmlEditor |
The default text for the create link prompt |
|
defaultLinkValue : String |
HtmlEditor |
The default value for the create link prompt (defaults to http:/ /) |
|
disableClass : String |
Component |
CSS class added to the component when it is disabled (defaults to "x-item-disabled"). |
|
disabled : Boolean |
Field |
True to disable the field (defaults to false). |
|
enableAlignments : Boolean |
HtmlEditor |
Enable the left, center, right alignment buttons (defaults to true) |
|
enableColors : Boolean |
HtmlEditor |
Enable the fore/highlight color buttons (defaults to true) |
|
enableFont : Boolean |
HtmlEditor |
Enable font selection. Not available in Safari. (defaults to true) |
|
enableFontSize : Boolean |
HtmlEditor |
Enable the increase/decrease font size buttons (defaults to true) |
|
enableFormat : Boolean |
HtmlEditor |
Enable the bold, italic and underline buttons (defaults to true) |
|
enableLinks : Boolean |
HtmlEditor |
Enable the create link button. Not available in Safari. (defaults to true) |
|
enableLists : Boolean |
HtmlEditor |
Enable the bullet and numbered list buttons. Not available in Safari. (defaults to true) |
|
enableSourceEdit : Boolean |
HtmlEditor |
Enable the switch to source edit button. Not available in Safari. (defaults to true) |
|
fontFamilies : Array |
HtmlEditor |
An array of available font families |
|
hideMode : String |
Component |
How this component should hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset posi... |
|
msgTarget : String |
Field |
The location where error text should display. Should be one of the following values (defaults to 'qtip'): Value ... |
|
name : String |
Field |
The field's HTML name attribute. |
|
readOnly : Boolean |
Field |
True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM att... |
|
tabIndex : Number |
Field |
The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyT... |
|
validationDelay : Number |
Field |
The length of time in milliseconds after user input begins until validation is initiated (defaults to 250) |
|
validationEvent : String/Boolean |
Field |
The event that should initiate field validation. Set to false to disable automatic validation (defaults to "keyup"). |
|
value : Mixed |
Field |
A value to initialize this field with. |
allowDomMove
allowDomMove : Boolean
Whether the component can move the Dom node when rendering (defaults to true).
cls
cls : String
A CSS class to apply to the field's underlying element.
This config option is defined by
Field.
createLinkText
createLinkText : String
The default text for the create link prompt
This config option is defined by HtmlEditor.
defaultLinkValue
defaultLinkValue : String
The default value for the create link prompt (defaults to http:/ /)
This config option is defined by HtmlEditor.
disableClass
disableClass : String
CSS class added to the component when it is disabled (defaults to "x-item-disabled").
disabled
disabled : Boolean
True to disable the field (defaults to false).
This config option is defined by
Field.
enableAlignments
enableAlignments : Boolean
Enable the left, center, right alignment buttons (defaults to true)
This config option is defined by HtmlEditor.
enableColors
enableColors : Boolean
Enable the fore/highlight color buttons (defaults to true)
This config option is defined by HtmlEditor.
enableFont
enableFont : Boolean
Enable font selection. Not available in Safari. (defaults to true)
This config option is defined by HtmlEditor.
enableFontSize
enableFontSize : Boolean
Enable the increase/decrease font size buttons (defaults to true)
This config option is defined by HtmlEditor.
enableFormat
enableFormat : Boolean
Enable the bold, italic and underline buttons (defaults to true)
This config option is defined by HtmlEditor.
enableLinks
enableLinks : Boolean
Enable the create link button. Not available in Safari. (defaults to true)
This config option is defined by HtmlEditor.
enableLists
enableLists : Boolean
Enable the bullet and numbered list buttons. Not available in Safari. (defaults to true)
This config option is defined by HtmlEditor.
enableSourceEdit
enableSourceEdit : Boolean
Enable the switch to source edit button. Not available in Safari. (defaults to true)
This config option is defined by HtmlEditor.
fontFamilies
fontFamilies : Array
An array of available font families
This config option is defined by HtmlEditor.
hideMode
hideMode : String
How this component should hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset position) and "display" (css display) - defaults to "display".
msgTarget
msgTarget : String
The location where error text should display. Should be one of the following values (defaults to 'qtip'):
Value Description
----------- ----------------------------------------------------------------------
qtip Display a quick tip when the user hovers over the field
title Display a default browser title attribute popup
under Add a block div beneath the field containing the error text
side Add an error icon to the right of the field with a popup on hover
[element id] Add the error text directly to the innerHTML of the specified element
This config option is defined by
Field.
name
name : String
The field's HTML name attribute.
This config option is defined by
Field.
readOnly
readOnly : Boolean
True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.
This config option is defined by
Field.
tabIndex
tabIndex : Number
The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).
This config option is defined by
Field.
validationDelay
validationDelay : Number
The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)
This config option is defined by
Field.
validationEvent
validationEvent : String/Boolean
The event that should initiate field validation. Set to false to disable automatic validation (defaults to "keyup").
This config option is defined by
Field.
value
value : Mixed
A value to initialize this field with.
This config option is defined by
Field.