Package: | Ext |
Class: | Editor |
Extends: | Component |
Subclasses: | TreeEditor |
Defined In: | Editor.js |
Property | Defined By | |
---|---|---|
disabled : Object | Component | |
true if this component is disabled. Read-only. | ||
hidden : Object | Component | |
true if this component is hidden. Read-only. | ||
rendered : Object | Component | |
true if this component has been rendered. Read-only. |
Method | Defined By | |
---|---|---|
Editor( Ext.form.Field field , Object config ) |
Editor | |
Create a new Editor | ||
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 | ||
cancelEdit( Boolean remainVisible ) : void |
Editor | |
Cancels the editing process and hides the editor without persisting any changes. The field value will be reverted to... | ||
completeEdit( Boolean remainVisible ) : void |
Editor | |
Ends the editing process, persists the changed value to the underlying field, and hides the editor. | ||
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. | ||
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. | ||
getEl() : Ext.Element | Component | |
Returns the underlying Ext.Element. | ||
getId() : String | Component | |
Returns the id of this component. | ||
getValue() : Mixed | Editor | |
Gets the data value of the editor | ||
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. | ||
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) | ||
purgeListeners() : void | Observable | |
Removes all listeners for this object | ||
realign() : void | Editor | |
Realigns the editor to the bound field based on the current alignment config value. | ||
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. | ||
setDisabled( Boolean disabled ) : void |
Component | |
Convenience function for setting disabled/enabled by boolean. | ||
setSize( Number width , Number height ) : void |
Editor | |
Sets the height and width of this editor. | ||
setValue( Mixed value ) : void |
Editor | |
Sets the data value of the editor | ||
setVisible( Boolean visible ) : Ext.Component |
Component | |
Convenience function to hide or show this component by boolean. | ||
show() : Ext.Component | Component | |
Show this component. | ||
startEdit( String/HTMLElement/Element el , [String value ] ) : void |
Editor | |
Starts the editing process and shows the editor. | ||
un( String eventName , Function handler , [Object scope ] ) : void |
Observable | |
Removes a listener (shorthand for removeListener) |
Event | Defined By | |
---|---|---|
beforecomplete : ( Editor this , Mixed value , Mixed startValue ) |
Editor | |
Fires after a change has been made to the field, but before the change is reflected in the underlying field. Saving ... | ||
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. | ||
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. | ||
beforestartedit : ( Editor this , Ext.Element boundEl , Mixed value ) |
Editor | |
Fires when editing is initiated, but before the value changes. Editing can be canceled by returning false from the h... | ||
complete : ( Editor this , Mixed value , Mixed startValue ) |
Editor | |
Fires after editing is complete and any changed value has been written to the underlying field. | ||
destroy : ( Ext.Component this ) |
Component | |
Fires after the component is destroyed. | ||
disable : ( Ext.Component this ) |
Component | |
Fires after the component is disabled. | ||
enable : ( Ext.Component this ) |
Component | |
Fires after the component is enabled. | ||
hide : ( Ext.Component this ) |
Component | |
Fires after the component is hidden. | ||
render : ( Ext.Component this ) |
Component | |
Fires after the component is rendered. | ||
show : ( Ext.Component this ) |
Component | |
Fires after the component is shown. | ||
specialkey : ( Ext.form.Field this , Ext.EventObject e ) |
Editor | |
Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check Ext.EventObject.g... | ||
startedit : ( Ext.Element boundEl , Mixed value ) |
Editor | |
Fires when this editor is displayed |
Config Options | Defined By | |
---|---|---|
alignment : String | Editor | |
The position to align to (see Ext.Element.alignTo for more details, defaults to "c-c?"). | ||
allowDomMove : Boolean | Component | |
Whether the component can move the Dom node when rendering (defaults to true). | ||
autosize : Boolean/String | Editor | |
True for the editor to automatically adopt the size of the underlying field, "width" to adopt the width only, or "hei... | ||
cancelOnEsc : Boolean | Editor | |
True to cancel the edit when the escape key is pressed (defaults to false) | ||
completeOnEnter : Boolean | Editor | |
True to complete the edit when the enter key is pressed (defaults to false) | ||
constrain : Boolean | Editor | |
True to constrain the editor to the viewport | ||
disableClass : String | Component | |
CSS class added to the component when it is disabled (defaults to "x-item-disabled"). | ||
hideEl : Boolean | Editor | |
False to keep the bound element visible while the editor is displayed (defaults to true) | ||
hideMode : String | Component | |
How this component should hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset posi... | ||
ignoreNoChange : Boolean | Editor | |
True to skip the the edit completion process (no save, no events fired) if the user completes an edit and the value h... | ||
revertInvalid : Boolean | Editor | |
True to automatically revert the field value and cancel the edit when the user completes an edit and the field valida... | ||
shadow : Boolean/String | Editor | |
"sides" for sides/bottom only, "frame" for 4-way shadow, and "drop" for bottom-right shadow (defaults to "frame") | ||
updateEl : Boolean | Editor | |
True to update the innerHTML of the bound element when the update completes (defaults to false) | ||
value : Mixed | Editor | |
The data value of the underlying field (defaults to "") |
public Object disabled
public Object hidden
public Object rendered
public function Editor( Ext.form.Field field
, Object config
)
field
: Ext.form.Fieldconfig
: Objectpublic function addEvents( Object object
)
object
: Objectvoid
public function addListener( String eventName
, Function handler
, [Object scope
], [Object options
] )
eventName
: Stringhandler
: Functionscope
: Objectoptions
: Object
Combining Options
Using the options argument, it is possible to combine different types of listeners:
A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
el.on('click', this.onClick, this, {
single: true,
delay: 100,
forumId: 4
});
Attaching multiple handlers in 1 call
The method also allows for a single argument to be passed which is a config object containing properties
which specify multiple handlers.
el.on({
'click': {
fn: this.onClick,
scope: this,
delay: 100
},
'mouseover': {
fn: this.onMouseOver,
scope: this
},
'mouseout': {
fn: this.onMouseOut,
scope: this
}
});
Or a shorthand syntax which passes the same scope object to all handlers:
el.on({
'click': this.onClick,
'mouseover': this.onMouseOver,
'mouseout': this.onMouseOut,
scope: this
});
void
public function cancelEdit( Boolean remainVisible
)
remainVisible
: Booleanvoid
public function completeEdit( Boolean remainVisible
)
remainVisible
: Booleanvoid
public function destroy()
void
public function disable()
Ext.Component
public function enable()
Ext.Component
public function fireEvent( String eventName
, Object... args
)
eventName
: Stringargs
: Object...Boolean
public function focus( Boolean selectText
)
selectText
: BooleanExt.Component
public function getEl()
Ext.Element
public function getId()
String
public function getValue()
Mixed
public function hasListener( String eventName
)
eventName
: StringBoolean
public function hide()
Ext.Component
public function isVisible()
void
public function on( String eventName
, Function handler
, [Object scope
], [Object options
] )
eventName
: Stringhandler
: Functionscope
: Objectoptions
: Objectvoid
public function purgeListeners()
void
public function realign()
void
public function removeListener( String eventName
, Function handler
, [Object scope
] )
eventName
: Stringhandler
: Functionscope
: Objectvoid
public function render( [String/HTMLElement/Element container
] )
container
: String/HTMLElement/Elementvoid
public function setDisabled( Boolean disabled
)
disabled
: Booleanvoid
public function setSize( Number width
, Number height
)
width
: Numberheight
: Numbervoid
public function setValue( Mixed value
)
value
: Mixedvoid
public function setVisible( Boolean visible
)
visible
: BooleanExt.Component
public function show()
Ext.Component
public function startEdit( String/HTMLElement/Element el
, [String value
] )
el
: String/HTMLElement/Elementvalue
: Stringvoid
public function un( String eventName
, Function handler
, [Object scope
] )
eventName
: Stringhandler
: Functionscope
: Objectvoid
public event beforecomplete
this
: Editorvalue
: MixedstartValue
: Mixedpublic event beforedestroy
this
: Ext.Componentpublic event beforehide
this
: Ext.Componentpublic event beforerender
this
: Ext.Componentpublic event beforeshow
this
: Ext.Componentpublic event beforestartedit
this
: EditorboundEl
: Ext.Elementvalue
: Mixedpublic event complete
this
: Editorvalue
: MixedstartValue
: Mixedpublic event destroy
this
: Ext.Componentpublic event disable
this
: Ext.Componentpublic event enable
this
: Ext.Componentpublic event hide
this
: Ext.Componentpublic event render
this
: Ext.Componentpublic event show
this
: Ext.Componentpublic event specialkey
this
: Ext.form.Fielde
: Ext.EventObjectpublic event startedit
boundEl
: Ext.Elementvalue
: Mixedalignment : String
allowDomMove : Boolean
autosize : Boolean/String
cancelOnEsc : Boolean
completeOnEnter : Boolean
constrain : Boolean
disableClass : String
hideEl : Boolean
hideMode : String
ignoreNoChange : Boolean
revertInvalid : Boolean
shadow : Boolean/String
updateEl : Boolean
value : Mixed