Roo.util.Observable Roo.Component Roo.Editor Roo.tree.TreeEditor
Package: | Roo.tree |
Defined In: | Roo/tree/TreeEditor.js. |
Class: | TreeEditor |
Extends: | Roo.Editor |
Options | Defined By | |
---|---|---|
actionMode : String
which property holds the element that used for hide() / show() / disable() / enable()
default is 'el'
which property holds the element that used for hide() / show() / disable() / enable()
default is 'el' |
Roo.Component | |
alignment : String
The position to align to (see {link Roo.ElementalignTo} for more details, defaults to "l-l").
The position to align to (see {link Roo.ElementalignTo} for more details, defaults to "l-l").
|
Roo.tree.TreeEditor | |
allowDomMove : Boolean
Whether the component can move the Dom node when rendering (defaults to true).
Whether the component can move the Dom node when rendering (defaults to true).
|
Roo.Component | |
autosize : Boolean/String
True for the editor to automatically adopt the size of the underlying field, "width" to adopt the width only,
or "height" to adopt the height only (defaults to false)
True for the editor to automatically adopt the size of the underlying field, "width" to adopt the width only,
or "height" to adopt the height only (defaults to false) |
Roo.Editor | |
cancelOnEsc : Boolean
True to cancel the edit when the escape key is pressed (defaults to false)
True to cancel the edit when the escape key is pressed (defaults to false)
|
Roo.Editor | |
cls : String
CSS class to apply to the editor (defaults to "x-small-editor x-tree-editor")
CSS class to apply to the editor (defaults to "x-small-editor x-tree-editor")
|
Roo.tree.TreeEditor | |
completeOnEnter : Boolean
True to complete the edit when the enter key is pressed (defaults to false)
True to complete the edit when the enter key is pressed (defaults to false)
|
Roo.Editor | |
constrain : Boolean
True to constrain the editor to the viewport
True to constrain the editor to the viewport
|
Roo.Editor | |
disableClass : String
CSS class added to the component when it is disabled (defaults to "x-item-disabled").
CSS class added to the component when it is disabled (defaults to "x-item-disabled").
|
Roo.Component | |
field : Roo.form.TextField|Object
The field configuration
The field configuration
|
Roo.tree.TreeEditor | |
hideEl : Boolean
True to hide the bound element while the editor is displayed (defaults to false)
True to hide the bound element while the editor is displayed (defaults to false)
|
Roo.tree.TreeEditor | |
hideMode : String
How this component should hidden.
How this component should hidden. Supported values are
"visibility" (css visibility), "offsets" (negative offset position) and "display" (css display) - defaults to "display". Possible Values: display, visibility |
Roo.Component | |
ignoreNoChange : Boolean
True to skip the the edit completion process (no save, no events fired) if the user completes an edit and
the value has not changed (defaults to false).
True to skip the the edit completion process (no save, no events fired) if the user completes an edit and
the value has not changed (defaults to false). Applies only to string values - edits for other data types will never be ignored. |
Roo.Editor | |
listeners : Object
list of events and functions to call for this object,
For example :
list of events and functions to call for this object,
For example :
|
Roo.util.Observable | |
maxWidth : Number
The maximum width in pixels of the editor field (defaults to 250).
The maximum width in pixels of the editor field (defaults to 250). Note that if the maxWidth would exceed
the containing tree element's size, it will be automatically limited for you to the container width, taking scroll and client offsets into account prior to each edit. |
Roo.tree.TreeEditor | |
revertInvalid : Boolean
True to automatically revert the field value and cancel the edit when the user completes an edit and the field
validation fails (defaults to true)
True to automatically revert the field value and cancel the edit when the user completes an edit and the field
validation fails (defaults to true) |
Roo.Editor | |
shadow : Boolean/String
"sides" for sides/bottom only, "frame" for 4-way shadow, and "drop"
for bottom-right shadow (defaults to "frame")
"sides" for sides/bottom only, "frame" for 4-way shadow, and "drop"
for bottom-right shadow (defaults to "frame") |
Roo.Editor | |
shim : Boolean
True to shim the editor if selects/iframes could be displayed beneath it (defaults to false)
True to shim the editor if selects/iframes could be displayed beneath it (defaults to false)
|
Roo.tree.TreeEditor | |
tree : Roo.tree.TreePanel
The tree to bind to.
The tree to bind to.
|
Roo.tree.TreeEditor | |
updateEl : Boolean
True to update the innerHTML of the bound element when the update completes (defaults to false)
True to update the innerHTML of the bound element when the update completes (defaults to false)
|
Roo.Editor | |
value : Mixed
The data value of the underlying field (defaults to "")
The data value of the underlying field (defaults to "")
|
Roo.Editor |
Method | Defined By | |
---|---|---|
addEvents
(Object object)
Used to define events on this Observable
Used to define events on this Observable
|
Roo.util.Observable | |
Appends an event handler to this component
Appends an event handler to this component
|
Roo.util.Observable | |
cancelEdit
(Boolean remainVisible)
Cancels the editing process and hides the editor without persisting any changes.
Cancels the editing process and hides the editor without persisting any changes. The field value will be
reverted to the original starting value.
|
Roo.Editor | |
completeEdit
(Boolean remainVisible)
Ends the editing process, persists the changed value to the underlying field, and hides the editor.
Ends the editing process, persists the changed value to the underlying field, and hides the editor.
|
Roo.Editor | |
destroy
()
Destroys this component by purging any event listeners, removing the component's element from the DOM,
removing the component from its {link Roo.Container} (if applicable) and unregistering it from {link Roo.ComponentMgr}.
Destroys this component by purging any event listeners, removing the component's element from the DOM,
removing the component from its {link Roo.Container} (if applicable) and unregistering it from {link Roo.ComponentMgr}. |
Roo.Component | |
disable
()
:
Roo.Component
Disable this component.
Disable this component.
|
Roo.Component | |
enable
()
:
Roo.Component
Enable this component.
Enable this component.
|
Roo.Component | |
Fires the specified event with the passed parameters (minus the event name).
|
Roo.util.Observable | |
focus
(Boolean selectText)
:
Roo.Component
Try to focus this component.
Try to focus this component.
|
Roo.Component | |
getEl
()
:
Roo.Element
Returns the underlying {link Roo.Element}.
Returns the underlying {link Roo.Element}.
|
Roo.Component | |
getId
()
:
String
Returns the id of this component.
Returns the id of this component.
|
Roo.Component | |
getValue
()
:
Mixed
Gets the data value of the editor
Gets the data value of the editor
|
Roo.Editor | |
Roo.util.Observable | ||
hide
()
:
Roo.Component
Hide this component.
Hide this component.
|
Roo.Component | |
isVisible
()
Returns true if this component is visible.
Returns true if this component is visible.
|
Roo.Component | |
Appends an event handler to this element (shorthand for addListener)
Appends an event handler to this element (shorthand for addListener)
|
Roo.util.Observable | |
purgeListeners
()
Removes all listeners for this object
Removes all listeners for this object
|
Roo.util.Observable | |
realign
()
Realigns the editor to the bound field based on the current alignment config value.
Realigns the editor to the bound field based on the current alignment config value.
|
Roo.Editor | |
Roo.util.Observable | ||
render
(String/HTMLElement/Element container)
If this is a lazy rendering component, render it to its container element.
If this is a lazy rendering component, render it to its container element.
|
Roo.Component | |
setDisabled
(Boolean disabled)
Convenience function for setting disabled/enabled by boolean.
Convenience function for setting disabled/enabled by boolean.
|
Roo.Component | |
Roo.Editor | ||
setValue
(Mixed value)
Sets the data value of the editor
Sets the data value of the editor
|
Roo.Editor | |
setVisible
(Boolean visible)
:
Roo.Component
Convenience function to hide or show this component by boolean.
Convenience function to hide or show this component by boolean.
|
Roo.Component | |
show
()
:
Roo.Component
Show this component.
Show this component.
|
Roo.Component | |
Roo.Editor | ||
Roo.util.Observable |
Event | Defined By | |
---|---|---|
beforecomplete (Editor this, Mixed value, Mixed startValue)
Fires after a change has been made to the field, but before the change is reflected in the underlying
field.
Fires after a change has been made to the field, but before the change is reflected in the underlying
field. Saving the change to the field can be canceled by returning false from the handler of this event. Note that if the value has not changed and ignoreNoChange = true, the editing will still end but this event will not fire since no edit actually occurred.
|
Roo.Editor | |
beforedestroy (Roo.Component this)
Fires before the component is destroyed.
Fires before the component is destroyed. Return false to stop the destroy.
|
Roo.Component | |
beforehide (Roo.Component this)
Fires before the component is hidden.
Fires before the component is hidden. Return false to stop the hide.
|
Roo.Component | |
beforenodeedit (Editor this, Roo.tree.Node node)
Fires when editing is initiated, but before the value changes.
Fires when editing is initiated, but before the value changes. Editing can be canceled by returning
false from the handler of this event.
|
Roo.tree.TreeEditor | |
beforerender (Roo.Component this)
Fires before the component is rendered.
Fires before the component is rendered. Return false to stop the render.
|
Roo.Component | |
beforeshow (Roo.Component this)
Fires before the component is shown.
Fires before the component is shown. Return false to stop the show.
|
Roo.Component | |
beforestartedit (Editor this, Roo.Element boundEl, Mixed value)
Fires when editing is initiated, but before the value changes.
Fires when editing is initiated, but before the value changes. Editing can be canceled by returning
false from the handler of this event.
|
Roo.Editor | |
complete (Editor this, Mixed value, Mixed startValue)
Fires after editing is complete and any changed value has been written to the underlying field.
Fires after editing is complete and any changed value has been written to the underlying field.
|
Roo.Editor | |
destroy (Roo.Component this)
Fires after the component is destroyed.
Fires after the component is destroyed.
|
Roo.Component | |
disable (Roo.Component this)
Fires after the component is disabled.
Fires after the component is disabled.
|
Roo.Component | |
enable (Roo.Component this)
Fires after the component is enabled.
Fires after the component is enabled.
|
Roo.Component | |
hide (Roo.Component this)
Fires after the component is hidden.
Fires after the component is hidden.
|
Roo.Component | |
render (Roo.Component this)
Fires after the component is rendered.
Fires after the component is rendered.
|
Roo.Component | |
show (Roo.Component this)
Fires after the component is shown.
Fires after the component is shown.
|
Roo.Component | |
specialkey (Roo.form.Field this, Roo.EventObject e)
Fires when any key related to navigation (arrows, tab, enter, esc, etc.
Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check
{link Roo.EventObjectgetKey} to determine which key was pressed.
|
Roo.Editor | |
startedit (Roo.Element boundEl, Mixed value)
Fires when this editor is displayed
Fires when this editor is displayed
|
Roo.Editor |