Roo.util.Observable Roo.Component Roo.bootstrap.Component Roo.bootstrap.Input Roo.bootstrap.TextArea Roo.bootstrap.HtmlEditor
Package: | Roo.bootstrap |
Defined In: | Roo/bootstrap/HtmlEditor.js. |
Class: | HtmlEditor |
Extends: | Roo.bootstrap.TextArea |
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 | |
after : string
- input group add on after
- input group add on after
|
Roo.bootstrap.Input | |
align : String
Default left
Default left
Possible Values: left, center, right |
Roo.bootstrap.Input | |
allowBlank : Boolean
False to validate that the value length > 0 (defaults to true)
False to validate that the value length > 0 (defaults to true)
|
Roo.bootstrap.Input | |
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 | |
autocomplete : String
- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en
- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en
|
Roo.bootstrap.Input | |
before : string
- input group add on before
- input group add on before
|
Roo.bootstrap.Input | |
blankText : String
Error text to display if the allow blank validation fails (defaults to "This field is required")
Error text to display if the allow blank validation fails (defaults to "This field is required")
|
Roo.bootstrap.Input | |
buttons : Array
Array of toolbar's buttons.
Array of toolbar's buttons. - defaults to empty
|
Roo.bootstrap.HtmlEditor | |
can_build_overlaid : Boolean
True if element can be rebuild from a HTML page
True if element can be rebuild from a HTML page
|
Roo.bootstrap.Component | |
cls : String
css class
css class
|
Roo.bootstrap.Component | |
cols : Number
Specifies the visible width of a text area
Specifies the visible width of a text area
|
Roo.bootstrap.TextArea | |
container_method : string
method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)
method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)
|
Roo.bootstrap.Component | |
dataId : string
cutomer id
cutomer id
|
Roo.bootstrap.Component | |
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 | |
disableKeyFilter : Boolean
True to disable input keystroke filtering (defaults to false)
True to disable input keystroke filtering (defaults to false)
|
Roo.bootstrap.Input | |
disabled : Boolean
is it disabled
is it disabled
|
Roo.bootstrap.Input | |
fieldLabel : string
- the label associated
- the label associated
|
Roo.bootstrap.Input | |
forceFeedback : Boolean
Default false
Default false
Possible Values: true, false |
Roo.bootstrap.Input | |
hasFeedback : Boolean
default true
default true
Possible Values: true, false |
Roo.bootstrap.Input | |
height : Number
(in pixels)
(in pixels)
|
Roo.bootstrap.HtmlEditor | |
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 | |
html : string
text
text
|
Roo.bootstrap.TextArea | |
indicatorpos : String
default left
default left
Possible Values: left, right |
Roo.bootstrap.Input | |
invalidFeedbackIcon : String
The CSS class to use when create feedback icon (defaults to "x-form-invalid")
The CSS class to use when create feedback icon (defaults to "x-form-invalid")
|
Roo.bootstrap.Input | |
labelAlign : String
Possible Values: top, left |
Roo.bootstrap.Input | |
labelWidth : Number
set the width of label
set the width of label
|
Roo.bootstrap.Input | |
labellg : Number
set the width of label (1-12)
set the width of label (1-12)
|
Roo.bootstrap.Input | |
labelmd : Number
set the width of label (1-12)
set the width of label (1-12)
|
Roo.bootstrap.Input | |
labelsm : Number
set the width of label (1-12)
set the width of label (1-12)
|
Roo.bootstrap.Input | |
labelxs : Number
set the width of label (1-12)
set the width of label (1-12)
|
Roo.bootstrap.Input | |
lg : Number
colspan out of 12 for large computer-sized screens
colspan out of 12 for large computer-sized screens
|
Roo.bootstrap.Input | |
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 | |
maskRe : String
An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)
An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)
|
Roo.bootstrap.Input | |
maxLength : Number
Maximum input field length allowed (defaults to Number.MAX_VALUE)
Maximum input field length allowed (defaults to Number.MAX_VALUE)
|
Roo.bootstrap.Input | |
maxLengthText : String
Error text to display if the maximum length validation fails (defaults to "The maximum length for this field is {maxLength}")
Error text to display if the maximum length validation fails (defaults to "The maximum length for this field is {maxLength}")
|
Roo.bootstrap.Input | |
md : Number
colspan out of 12 for computer-sized screens
colspan out of 12 for computer-sized screens
|
Roo.bootstrap.Input | |
minLength : Number
Minimum input field length required (defaults to 0)
Minimum input field length required (defaults to 0)
|
Roo.bootstrap.Input | |
minLengthText : String
Error text to display if the minimum length validation fails (defaults to "The minimum length for this field is {minLength}")
Error text to display if the minimum length validation fails (defaults to "The minimum length for this field is {minLength}")
|
Roo.bootstrap.Input | |
name : String
name of the input
name of the input
|
Roo.bootstrap.Input | |
placeholder : string
- placeholder to put in text.
- placeholder to put in text.
|
Roo.bootstrap.Input | |
readOnly : Boolean
Specifies that the field should be read-only
Specifies that the field should be read-only
|
Roo.bootstrap.Input | |
regex : RegExp
A JavaScript RegExp object to be tested against the field value during validation (defaults to null).
A JavaScript RegExp object to be tested against the field value during validation (defaults to null).
If available, this regex will be evaluated only after the basic validators all return true, and will be passed the current field value. If the test fails, the field will be marked invalid using {link regexText}. |
Roo.bootstrap.Input | |
regexText : String
-- Depricated - use Invalid Text
-- Depricated - use Invalid Text
|
Roo.bootstrap.Input | |
resizable : String
's' or 'se' or 'e' - wrapps the element in a
Roo.resizable.
's' or 'se' or 'e' - wrapps the element in a
Roo.resizable. |
Roo.bootstrap.HtmlEditor | |
resize : string
Possible Values: none, both, horizontal, vertical, inherit, initial |
Roo.bootstrap.TextArea | |
rows : Number
Specifies the visible number of lines in a text area
Specifies the visible number of lines in a text area
|
Roo.bootstrap.TextArea | |
selectOnFocus : Boolean
True to automatically select any existing field text when the field receives input focus (defaults to false)
True to automatically select any existing field text when the field receives input focus (defaults to false)
|
Roo.bootstrap.Input | |
size : string
- (lg|sm) or leave empty.
- (lg|sm) or leave empty..
|
Roo.bootstrap.Input | |
sm : Number
colspan out of 12 for tablet-sized screens
colspan out of 12 for tablet-sized screens
|
Roo.bootstrap.Input | |
style : String
any extra css
any extra css
|
Roo.bootstrap.Component | |
stylesheets : Array
url of stylesheets.
url of stylesheets. set to [] to disable stylesheets.
|
Roo.bootstrap.HtmlEditor | |
toolbars : Array
Array of toolbars.
Array of toolbars. - defaults to just the Standard one
|
Roo.bootstrap.HtmlEditor | |
tooltip : string
Text for the tooltip
Text for the tooltip
|
Roo.bootstrap.Component | |
validClass : String
The CSS class to use when marking a field valid (defaults to "x-form-invalid")
The CSS class to use when marking a field valid (defaults to "x-form-invalid")
|
Roo.bootstrap.Input | |
validFeedbackIcon : String
The CSS class to use when create feedback icon (defaults to "x-form-invalid")
The CSS class to use when create feedback icon (defaults to "x-form-invalid")
|
Roo.bootstrap.Input | |
validationDelay : Number
The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)
The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)
|
Roo.bootstrap.Input | |
validationEvent : String/Boolean
The event that should initiate field validation.
The event that should initiate field validation. Set to false to disable
automatic validation (defaults to "keyup"). |
Roo.bootstrap.Input | |
validator : Function
A custom validation function to be called during field validation (defaults to null).
A custom validation function to be called during field validation (defaults to null).
If available, this function will be called only after the basic validators all return true, and will be passed the current field value and expected to return boolean true if the value is valid or a string error message if invalid. |
Roo.bootstrap.Input | |
value : string
default value of the input
default value of the input
|
Roo.bootstrap.Input | |
visibilityEl : string|object
What element to use for visibility (see getVisibilityEl())
What element to use for visibility (see getVisibilityEl())
Possible Values: el, parent |
Roo.bootstrap.Component | |
vtype : String
A validation type name as defined in {link Roo.form.VTypes} (defaults to null)
A validation type name as defined in {link Roo.form.VTypes} (defaults to null)
|
Roo.bootstrap.Input | |
width : Number
(in pixels)
(in pixels)
|
Roo.bootstrap.HtmlEditor | |
wrap : string
Specifies how the text in a text area is to be wrapped when submitted in a form
Specifies how the text in a text area is to be wrapped when submitted in a form
Possible Values: soft, hard |
Roo.bootstrap.TextArea | |
xattr : Object
extra attributes to add to 'element' (used by builder to store stuff.
extra attributes to add to 'element' (used by builder to store stuff.)
|
Roo.bootstrap.Component | |
xs : Number
colspan out of 12 for mobile-sized screens
colspan out of 12 for mobile-sized screens
|
Roo.bootstrap.Input |
Method | Defined By | |
---|---|---|
new Roo.bootstrap.HtmlEditor
(Object config)
Create a new Roo.bootstrap.HtmlEditor
Create a new Roo.bootstrap.HtmlEditor
|
||
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 | |
clearInvalid
()
Clear any invalid styles/messages for this field
Clear any invalid styles/messages for this field
|
Roo.bootstrap.TextArea | |
createToolbar
(HtmlEditor editor)
Protected method that will not generally be called directly.
Protected method that will not generally be called directly. It
is called when the editor creates its toolbar. Override this method if you need to add custom toolbar buttons.
|
Roo.bootstrap.HtmlEditor | |
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 | |
getChildContainer
()
:
Roo.Element
Fetch the element to add children to
Fetch the element to add children to
|
Roo.bootstrap.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 | |
getName
()
:
Mixed
Returns the name of the field
Returns the name of the field
|
Roo.bootstrap.Input | |
getRawValue
()
:
Mixed
Returns the raw data value which may or may not be a valid, defined value.
Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {link getValue}.
|
Roo.bootstrap.Input | |
getValue
()
:
Mixed
Returns the normalized data value (undefined or emptyText will be returned as '').
Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {link getRawValue}.
|
Roo.bootstrap.Input | |
getVisibilityEl
()
Get the element that will be used to show or hide
Get the element that will be used to show or hide
|
Roo.bootstrap.Component | |
Roo.util.Observable | ||
hide
()
Hide a component - adds 'hidden' class
Hide a component - adds 'hidden' class
|
Roo.bootstrap.Component | |
initEvents
()
Initialize Events for the element
Initialize Events for the element
|
Roo.bootstrap.Component | |
inputEl
()
return the real textarea element.
return the real textarea element.
|
Roo.bootstrap.TextArea | |
isVisible
()
Returns true if this component is visible.
Returns true if this component is visible.
|
Roo.Component | |
markInvalid
(String msg)
Mark this field as invalid
Mark this field as invalid
|
Roo.bootstrap.TextArea | |
markValid
()
Mark this field as valid
Mark this field as valid
|
Roo.bootstrap.TextArea | |
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 | |
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 | |
reset
()
Resets the current field value to the originally loaded value and clears any validation messages
Resets the current field value to the originally loaded value and clears any validation messages
|
Roo.bootstrap.Input | |
setDisabled
(Boolean disabled)
Convenience function for setting disabled/enabled by boolean.
Convenience function for setting disabled/enabled by boolean.
|
Roo.Component | |
setRawValue
(Mixed value)
Sets the underlying DOM field's value directly, bypassing validation.
Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {link setValue}.
|
Roo.bootstrap.Input | |
setValue
(Mixed value)
Sets a data value into the field and validates it.
Sets a data value into the field and validates it. To set the value directly without validation see {link setRawValue}.
|
Roo.bootstrap.Input | |
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
()
Show a component - removes 'hidden' class
Show a component - removes 'hidden' class
|
Roo.bootstrap.Component | |
toggleSourceEdit
(Boolean sourceEdit)
Toggles the editor between standard and source edit mode.
Toggles the editor between standard and source edit mode.
|
Roo.bootstrap.HtmlEditor | |
tooltipEl
()
:
Roo.Element
Fetch the element to display the tooltip on.
Fetch the element to display the tooltip on.
|
Roo.bootstrap.Component | |
Roo.util.Observable | ||
validate
()
:
Boolean
Validates the field value
Validates the field value
|
Roo.bootstrap.Input | |
validateValue
(Mixed value)
:
Boolean
Validates a value according to the field's validation rules and marks the field as invalid
if the validation fails
Validates a value according to the field's validation rules and marks the field as invalid
if the validation fails
|
Roo.bootstrap.Input |
Event | Defined By | |
---|---|---|
activate (HtmlEditor this)
Fires when the editor is first receives the focus.
Fires when the editor is first receives the focus. Any insertion must wait
until after this event.
|
Roo.bootstrap.HtmlEditor | |
autosave (HtmlEditor this)
Auto save the htmlEditor value as a file into Events
Auto save the htmlEditor value as a file into Events
|
Roo.bootstrap.HtmlEditor | |
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 | |
beforepush (HtmlEditor this, String html)
Fires before the iframe editor is updated with content from the textarea.
Fires before the iframe editor is updated with content from the textarea. Return false
to cancel the push.
|
Roo.bootstrap.HtmlEditor | |
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 | |
beforesync (HtmlEditor this, String html)
Fires before the textarea is updated with content from the editor iframe.
Fires before the textarea is updated with content from the editor iframe. Return false
to cancel the sync.
|
Roo.bootstrap.HtmlEditor | |
childrenrendered (Roo.bootstrap.Component this)
Fires when the children have been rendered.
Fires when the children have been rendered..
|
Roo.bootstrap.Component | |
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 | |
editmodechange (HtmlEditor this, Boolean sourceEdit)
Fires when the editor switches edit modes
Fires when the editor switches edit modes
|
Roo.bootstrap.HtmlEditor | |
editorevent (HtmlEditor this)
Fires when on any editor (mouse up/down cursor movement etc.
Fires when on any editor (mouse up/down cursor movement etc.) - used for toolbar hooks.
|
Roo.bootstrap.HtmlEditor | |
enable (Roo.Component this)
Fires after the component is enabled.
Fires after the component is enabled.
|
Roo.Component | |
firstfocus (HtmlEditor this)
Fires when on first focus - needed by toolbars.
Fires when on first focus - needed by toolbars..
|
Roo.bootstrap.HtmlEditor | |
hide (Roo.Component this)
Fires after the component is hidden.
Fires after the component is hidden.
|
Roo.Component | |
initialize (HtmlEditor this)
Fires when the editor is fully initialized (including the iframe)
Fires when the editor is fully initialized (including the iframe)
|
Roo.bootstrap.HtmlEditor | |
invalid (Roo.form.Field this, String msg)
Fires after the field has been marked as invalid.
Fires after the field has been marked as invalid.
|
Roo.bootstrap.Input | |
keyup (Roo.form.Field this, Roo.EventObject e)
Fires after the key up
Fires after the key up
|
Roo.bootstrap.Input | |
push (HtmlEditor this, String html)
Fires when the iframe editor is updated with content from the textarea.
Fires when the iframe editor is updated with content from the textarea.
|
Roo.bootstrap.HtmlEditor | |
render (Roo.Component this)
Fires after the component is rendered.
Fires after the component is rendered.
|
Roo.Component | |
savedpreview (HtmlEditor this)
preview the saved version of htmlEditor
preview the saved version of htmlEditor
|
Roo.bootstrap.HtmlEditor | |
show (Roo.Component this)
Fires after the component is shown.
Fires after the component is shown.
|
Roo.Component | |
sync (HtmlEditor this, String html)
Fires when the textarea is updated with content from the editor iframe.
Fires when the textarea is updated with content from the editor iframe.
|
Roo.bootstrap.HtmlEditor | |
valid (Roo.form.Field this)
Fires after the field has been validated with no errors.
Fires after the field has been validated with no errors.
|
Roo.bootstrap.Input |