- - - -

- -

- - - - -

Roo.util.Observable
-Roo.Component
-Roo.BoxComponent
-Roo.form.Field
-Roo.form.TextField
-Roo.form.ComboBoxArray 
-
-

- - - - -

- - Class Roo.form.ComboBoxArray -

- - - - - - - - - - - - - - -

Package:	Roo.form
Defined In:	- - Roo/form/ComboBoxArray.js. - -
Class:	ComboBoxArray
Extends:	- Roo.form.TextField - -

- - - -

- A facebook style adder... for lists of email / people / countries etc...
pick multiple items from a combo box, and shows each one.

Fred [x] Brian [x] [Pick another |v]

For this to work: it needs various extra information
- normal combo problay has
name, hiddenName
+ displayField, valueField

For our purpose...

If we change from 'extends' to wrapping... -

- - - - -

- Class Comments / Notes => - [Add Your comment/notes about this class] -
- -

- - - - - - - - -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Config Options (Usually are also Properties)
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 - -
	- - - - 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.form.TextField - -
	- - - - 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 - -
	- - - - autoCreate : String/Object - - - - - - A DomHelper element spec, or true for a default element spec (defaults to {tag: "input", type: "text", size: "20", autocomplete: "off"}) - - - - - A DomHelper element spec, or true for a default element spec (defaults to {tag: "input", type: "text", size: "20", autocomplete: "off"}) - - - - - - -	- - Roo.form.Field - -
	- - - - 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.form.TextField - -
	- - - - cls : String - - - - - - A CSS class to apply to the field's underlying element. - - - - - A CSS class to apply to the field's underlying element. - - - - - - -	- - Roo.form.Field - -
	- - - - combo : Roo.form.Combo - - - - - - The combo box that is wrapped - - - - - The combo box that is wrapped - - - - - - -	- - Roo.form.ComboBoxArray - -
	- - - - 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.form.TextField - -
	- - - - disabled : Boolean - - - - - - True to disable the field (defaults to false). - - - - - True to disable the field (defaults to false). - - - - - - -	- - Roo.form.Field - -
	- - - - emptyText : String - - - - - - The default text to display in an empty field - placeholder. - - - - - The default text to display in an empty field - placeholder... (defaults to null). - - - - - - -	- - Roo.form.TextField - -
	- - - - fieldClass : String - - - - - - The default CSS class for the field (defaults to "x-form-field") - - - - - The default CSS class for the field (defaults to "x-form-field") - - - - - - -	- - Roo.form.Field - -
	- - - - fieldLabel : String - - - - - - Label to use when rendering a form. - - - - - Label to use when rendering a form. - - - - - - -	- - Roo.form.Field - -
	- - - - focusClass : String - - - - - - The CSS class to use when the field receives focus (defaults to "x-form-focus") - - - - - The CSS class to use when the field receives focus (defaults to "x-form-focus") - - - - - - -	- - Roo.form.Field - -
	- - - - grow : Boolean - - - - - - True if this field should automatically grow and shrink to its content - - - - - True if this field should automatically grow and shrink to its content - - - - - - -	- - Roo.form.TextField - -
	- - - - growMax : Number - - - - - - The maximum width to allow when grow = true (defaults to 800) - - - - - The maximum width to allow when grow = true (defaults to 800) - - - - - - -	- - Roo.form.TextField - -
	- - - - growMin : Number - - - - - - The minimum width to allow when grow = true (defaults to 30) - - - - - The minimum width to allow when grow = true (defaults to 30) - - - - - - -	- - Roo.form.TextField - -
	- - - - height : Number - - - - - - height (optional) size of component - - - - - height (optional) size of component - - - - - - -	- - Roo.BoxComponent - -
	- - - - hiddenName : String - - - - - - The hidden name of the field, often contains an comma seperated list of names - - - - - The hidden name of the field, often contains an comma seperated list of names - - - - - - -	- - Roo.form.ComboBoxArray - -
	- - - - 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 - -
	- - - - inputType : String - - - - - - The type attribute for input fields -- e.g. - - - - - The type attribute for input fields -- e.g. radio, text, password (defaults to "text"). - - - - - - -	- - Roo.form.Field - -
	- - - - invalidClass : String - - - - - - The CSS class to use when marking a field invalid (defaults to "x-form-invalid") - - - - - The CSS class to use when marking a field invalid (defaults to "x-form-invalid") - - - - - - -	- - Roo.form.Field - -
	- - - - invalidText : String - - - - - - The error text to use when marking a field invalid and no message is provided (defaults to "The value in this field is invalid") - - - - - The error text to use when marking a field invalid and no message is provided (defaults to "The value in this field is invalid") - - - - - - -	- - Roo.form.Field - -
	- - - - listeners : Object - - - - - - list of events and functions to call for this object, For example : `listeners : { 'click' : function(e) { .` `-` `- - - - list of events and functions to call for this object, For example : listeners : { 'click' : function(e) { ..... } , .... } - - - - - - -`	- - 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.form.TextField - -
	- - - - maxLength : Number - - - - - - Maximum input field length allowed (defaults to Number.MAX_VALUE) - - - - - Maximum input field length allowed (defaults to Number.MAX_VALUE) - - - - - - -	- - Roo.form.TextField - -
	- - - - 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.form.TextField - -
	- - - - minLength : Number - - - - - - Minimum input field length required (defaults to 0) - - - - - Minimum input field length required (defaults to 0) - - - - - - -	- - Roo.form.TextField - -
	- - - - 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.form.TextField - -
	- - - - msgFx : String - - - - - - Experimental The effect used when displaying a validation message under the field (defaults to 'normal'). - - - - - Experimental The effect used when displaying a validation message under the field (defaults to 'normal'). - - - - - - -	- - Roo.form.Field - -
	- - - - msgTarget : String - - - - - - The location where error text should display. - - - - - 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 - - - - - - -	- - Roo.form.Field - -
	- - - - name : String - - - - - - The name of the visable items on this form (eg. - - - - - The name of the visable items on this form (eg. titles not ids) - - - - - - -	- - Roo.form.ComboBoxArray - -
	- - - - qtip : String - - - - - - Mouse over tip - - - - - Mouse over tip - - - - - - -	- - Roo.form.Field - -
	- - - - readOnly : Boolean - - - - - - True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute. - - - - - True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute. - - - - - - -	- - Roo.form.Field - -
	- - - - 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.form.TextField - -
	- - - - regexText : String - - - - - - The error text to display if {link regex} is used and the test fails during validation (defaults to "") - - - - - The error text to display if {link regex} is used and the test fails during validation (defaults to "") - - - - - - -	- - Roo.form.TextField - -
	- - - - 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.form.TextField - -
	- - - - tabIndex : Number - - - - - - The tabIndex for this field. - - - - - The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined). - - - - - - -	- - Roo.form.Field - -
	- - - - validateOnBlur : Boolean - - - - - - Whether the field should validate when it loses focus (defaults to true). - - - - - Whether the field should validate when it loses focus (defaults to true). - - - - - - -	- - Roo.form.Field - -
	- - - - 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.form.Field - -
	- - - - 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.form.Field - -
	- - - - 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.form.TextField - -
	- - - - value : Mixed - - - - - - A value to initialize this field with. - - - - - A value to initialize this field with. - - - - - - -	- - Roo.form.Field - -
	- - - - 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.form.TextField - -
	- - - - width : Number - - - - - - The width of the box that displays the selected element - - - - - The width of the box that displays the selected element - - - - - - -	- - Roo.form.ComboBoxArray - -

- - - - - - - - - - - - - - - - - - - - - -

Public Methods
Method		Defined By
	- - - new Roo.form.ComboBoxArray - - (Object *config) - - - - - - - - Create a new Roo.form.ComboBoxArray - - - - - - - Create a new Roo.form.ComboBoxArray - - - - Parameters: - - - Object config* - - - Configuration options - - - - - - - - - - - - - - - - -	- -
	- - - addEvents - - (Object *object) - - - - - - - Used to define events on this Observable - - - - - - Used to define events on this Observable - - - - - - - - Parameters: - - - Object object* - - - The object with the events defined - - - - - - - - - - - - - - - - -	- - Roo.util.Observable - -
	- - - addListener - - (String *eventName, Function handler, Object scope, Object options) - - - - - - - Appends an event handler to this component - - - - - - Appends an event handler to this component - - - - - - - - Parameters: - - - String eventName* - - - The type of event to listen for - - - Function handler - - - The method the event invokes - - - Object scope - - - (optional) The scope in which to execute the handler function. The handler function's "this" context. - - - Object options - - - (optional) An object containing handler configuration properties. This may contain any of the following properties: scope {Object} The scope in which to execute the handler function. The handler function's "this" context. delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires. single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself. buffer {Number} Causes the handler to be scheduled to run in an {link Roo.util.DelayedTask} delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place. 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 });` - - - - - - - - - - - - - - - - -	- - Roo.util.Observable - -
	- - - applyTo - - (String/HTMLElement/Element el) - - - : - - - Roo.form.Field - - - - - - - - - Apply the behaviors of this component to an existing element. - - - - - - Apply the behaviors of this component to an existing element. This is used instead of render(). - - - - - - - - Parameters: - - - String/HTMLElement/Element el - - - The id of the node, a DOM node or an existing Element - - - - - - - - - Returns: - - Roo.form.Field this - - - - - - - - - - - - -	- - Roo.form.Field - -
	- - - autoSize - - () - - - - - - - Automatically grows the field to accomodate the width of the text up to the maximum field width allowed. - - - - - - Automatically grows the field to accomodate the width of the text up to the maximum field width allowed. This only takes effect if grow = true, and fires the autosize event. - - - - - - - - - - - - - - - - - - - -	- - Roo.form.TextField - -
	- - - clearInvalid - - () - - - - - - - Clear any invalid styles/messages for this field - - - - - - Clear any invalid styles/messages for this field - - - - - - - - - - - - - - - - - - - -	- - Roo.form.Field - -
	- - - 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. - - - - - - - - - - - - Returns: - - Roo.Component this - - - - - - - - - - - - -	- - Roo.Component - -
	- - - enable - - () - - - : - - - Roo.Component - - - - - - - - - Enable this component. - - - - - - Enable this component. - - - - - - - - - - - - Returns: - - Roo.Component this - - - - - - - - - - - - -	- - Roo.Component - -
	- - - fireEvent - - (String *eventName, Object... args) - - - : - - - Boolean - - - - - - - - - Fires the specified event with the passed parameters (minus the event name). - - - - - - Fires the specified event with the passed parameters (minus the event name). - - - - - - - - Parameters: - - - String eventName* - - - - - - Object... args - - - Variable number of parameters are passed to handlers - - - - - - - - - Returns: - - Boolean returns false if any of the handlers return false otherwise it returns true - - - - - - - - - - - - -	- - Roo.util.Observable - -
	- - - focus - - (Boolean *selectText) - - - : - - - Roo.Component - - - - - - - - - Try to focus this component. - - - - - - Try to focus this component. - - - - - - - - Parameters: - - - Boolean selectText* - - - True to also select the text in this component (if applicable) - - - - - - - - - Returns: - - Roo.Component this - - - - - - - - - - - - -	- - Roo.Component - -
	- - - getBox - - (Boolean *local) - - - - - - - Gets the current box measurements of the component's underlying element. - - - - - - Gets the current box measurements of the component's underlying element. - - - - - - - - Parameters: - - - Boolean local* - - - (optional) If true the element's left and top are returned instead of page XY (defaults to false) - - - - - - - - - - - - - - - - -	- - Roo.BoxComponent - -
	- - - getEl - - () - - - : - - - Roo.Element - - - - - - - - - Returns the underlying {link Roo.Element}. - - - - - - Returns the underlying {link Roo.Element}. - - - - - - - - - - - - Returns: - - Roo.Element The element - - - - - - - - - - - - -	- - Roo.Component - -
	- - - getId - - () - - - : - - - String - - - - - - - - - Returns the id of this component. - - - - - - Returns the id of this component. - - - - - - - - - - - - Returns: - - String - - - - - - - - - - - - -	- - Roo.Component - -
	- - - getName - - () - - - : - - - String - - - - - - - - - Returns the name attribute of the field if available - - - - - - Returns the name attribute of the field if available - - - - - - - - - - - - Returns: - - String name The field name - - - - - - - - - - - - -	- - Roo.form.Field - -
	- - - getPosition - - (Boolean *local) - - - : - - - Array - - - - - - - - - Gets the current XY position of the component's underlying element. - - - - - - Gets the current XY position of the component's underlying element. - - - - - - - - Parameters: - - - Boolean local* - - - (optional) If true the element's left and top are returned instead of page XY (defaults to false) - - - - - - - - - Returns: - - Array The XY position of the element (e.g., [100, 200]) - - - - - - - - - - - - -	- - Roo.BoxComponent - -
	- - - 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}. - - - - - - - - - - - - Returns: - - Mixed value The field value - - - - - - - - - - - - -	- - Roo.form.Field - -
	- - - getSize - - () - - - : - - - Object - - - - - - - - - Gets the current size of the component's underlying element. - - - - - - Gets the current size of the component's underlying element. - - - - - - - - - - - - Returns: - - Object An object containing the element's size {width: (element width), height: (element height)} - - - - - - - - - - - - -	- - Roo.BoxComponent - -
	- - - 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}. - - - - - - - - - - - - Returns: - - Mixed value The field value - - - - - - - - - - - - -	- - Roo.form.Field - -
	- - - hasChanged - - () - - - - - - - checks the current value against the 'loaded' value. - - - - - - checks the current value against the 'loaded' value. Note - will return false if 'resetHasChanged' has not been called first. - - - - - - - - - - - - - - - - - - - -	- - Roo.form.Field - -
	- - - hasListener - - (String *eventName) - - - : - - - Boolean - - - - - - - - - Checks to see if this object has any listeners for a specified event - - - - - - Checks to see if this object has any listeners for a specified event - - - - - - - - Parameters: - - - String eventName* - - - The name of the event to check for - - - - - - - - - Returns: - - Boolean True if the event is being listened for, else false - - - - - - - - - - - - -	- - Roo.util.Observable - -
	- - - hide - - () - - - : - - - Roo.Component - - - - - - - - - Hide this component. - - - - - - Hide this component. - - - - - - - - - - - - Returns: - - Roo.Component this - - - - - - - - - - - - -	- - Roo.Component - -
	- - - isDirty - - () - - - - - - - Returns true if this field has been changed since it was originally loaded and is not disabled. - - - - - - Returns true if this field has been changed since it was originally loaded and is not disabled. DEPRICATED - it never worked well - use hasChanged/resetHasChanged. - - - - - - - - - - - - - - - - - - - -	- - Roo.form.Field - -
	- - - isValid - - (Boolean *preventMark) - - - : - - - Boolean - - - - - - - - - Returns whether or not the field value is currently valid - - - - - - Returns whether or not the field value is currently valid - - - - - - - - Parameters: - - - Boolean preventMark* - - - True to disable marking the field invalid - - - - - - - - - Returns: - - Boolean True if the value is valid, else false - - - - - - - - - - - - -	- - Roo.form.Field - -
	- - - 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 - - - - - - - - Parameters: - - - String msg* - - - The validation message - - - - - - - - - - - - - - - - -	- - Roo.form.Field - -
	- - - on - - (String *eventName, Function handler, Object scope, Object options) - - - - - - - Appends an event handler to this element (shorthand for addListener) - - - - - - Appends an event handler to this element (shorthand for addListener) - - - - - - - - Parameters: - - - String eventName* - - - The type of event to listen for - - - Function handler - - - The method the event invokes - - - Object scope - - - (optional) The scope in which to execute the handler function. The handler function's "this" context. - - - Object options - - - (optional) - - - - - - - - - - - - - - - - -	- - Roo.util.Observable - -
	- - - onPosition - - (Number x, Number y) - - - - - - - Called after the component is moved, this method is empty by default but can be implemented by any subclass that needs to perform custom logic after a move occurs. - - - - - - Called after the component is moved, this method is empty by default but can be implemented by any subclass that needs to perform custom logic after a move occurs. - - - - - - - - Parameters: - - - Number x - - - The new x position - - - Number y - - - The new y position - - - - - - - - - - - - - - - - -	- - Roo.BoxComponent - -
	- - - onResize - - (Number *adjWidth, Number adjHeight, Number rawWidth, Number rawHeight) - - - - - - - Called after the component is resized, this method is empty by default but can be implemented by any subclass that needs to perform custom logic after a resize occurs. - - - - - - Called after the component is resized, this method is empty by default but can be implemented by any subclass that needs to perform custom logic after a resize occurs. - - - - - - - - Parameters: - - - Number adjWidth* - - - The box-adjusted width that was set - - - Number adjHeight - - - The box-adjusted height that was set - - - Number rawWidth - - - The width that was originally specified - - - Number rawHeight - - - The height that was originally specified - - - - - - - - - - - - - - - - -	- - Roo.BoxComponent - -
	- - - purgeListeners - - () - - - - - - - Removes all listeners for this object - - - - - - Removes all listeners for this object - - - - - - - - - - - - - - - - - - - -	- - Roo.util.Observable - -
	- - - removeListener - - (String *eventName, Function handler, Object scope) - - - - - - - Removes a listener - - - - - - Removes a listener - - - - - - - - Parameters: - - - String eventName* - - - The type of event to listen for - - - Function handler - - - The handler to remove - - - Object scope - - - (optional) The scope (this object) for the handler - - - - - - - - - - - - - - - - -	- - 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. - - - - - - - - Parameters: - - - String/HTMLElement/Element container* - - - (optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off. - - - - - - - - - - - - - - - - -	- - 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.form.TextField - -
	- - - resetHasChanged - - () - - - - - - - stores the current value in loadedValue - - - - - - stores the current value in loadedValue - - - - - - - - - - - - - - - - - - - -	- - Roo.form.Field - -
	- - - selectText - - (Number *start, Number end) - - - - - - - Selects text in this field - - - - - - Selects text in this field - - - - - - - - Parameters: - - - Number start* - - - (optional) The index where the selection should start (defaults to 0) - - - Number end - - - (optional) The index where the selection should end (defaults to the text length) - - - - - - - - - - - - - - - - -	- - Roo.form.TextField - -
	- - - setDisabled - - (Boolean *disabled) - - - - - - - Convenience function for setting disabled/enabled by boolean. - - - - - - Convenience function for setting disabled/enabled by boolean. - - - - - - - - Parameters: - - - Boolean disabled* - - - - - - - - - - - - - - - - - - - -	- - Roo.Component - -
	- - - setPagePosition - - (Number x, Number y) - - - - - - - Sets the page XY position of the component. - - - - - - Sets the page XY position of the component. To set the left and top instead, use {link setPosition}. This method fires the move event. - - - - - - - - Parameters: - - - Number x - - - The new x position - - - Number y - - - The new y position - - - - - - - - - - - - - - - - -	- - Roo.BoxComponent - -
	- - - setPosition - - (Number *left, Number top) - - - - - - - Sets the left and top of the component. - - - - - - Sets the left and top of the component. To set the page XY position instead, use {link* setPagePosition}. This method fires the move event. - - - - - - - - Parameters: - - - Number left - - - The new left - - - Number top - - - The new top - - - - - - - - - - - - - - - - -	- - Roo.BoxComponent - -
	- - - 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}. - - - - - - - - Parameters: - - - Mixed value - - - The value to set - - - - - - - - - - - - - - - - -	- - Roo.form.Field - -
	- - - setSize - - (Number/Object *width, Number height) - - - : - - - Roo.BoxComponent - - - - - - - - - Sets the width and height of the component. - - - - - - Sets the width and height of the component. This method fires the resize event. This method can accept either width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}. - - - - - - - - Parameters: - - - Number/Object width* - - - The new width to set, or a size object in the format {width, height} - - - Number height - - - The new height to set (not required if a size object is passed as the first arg) - - - - - - - - - Returns: - - Roo.BoxComponent this - - - - - - - - - - - - -	- - Roo.BoxComponent - -
	- - - 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}. - - - - - - - - Parameters: - - - Mixed value - - - The value to set - - - - - - - - - - - - - - - - -	- - Roo.form.Field - -
	- - - 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. - - - - - - - - Parameters: - - - Boolean visible* - - - True to show, false to hide - - - - - - - - - Returns: - - Roo.Component this - - - - - - - - - - - - -	- - Roo.Component - -
	- - - show - - () - - - : - - - Roo.Component - - - - - - - - - Show this component. - - - - - - Show this component. - - - - - - - - - - - - Returns: - - Roo.Component this - - - - - - - - - - - - -	- - Roo.Component - -
	- - - syncSize - - () - - - - - - - Force the component's size to recalculate based on the underlying element's current height and width. - - - - - - Force the component's size to recalculate based on the underlying element's current height and width. - - - - - - - - - - - - - - - - - - - -	- - Roo.BoxComponent - -
	- - - un - - (String *eventName, Function handler, Object scope) - - - - - - - Removes a listener (shorthand for removeListener) - - - - - - Removes a listener (shorthand for removeListener) - - - - - - - - Parameters: - - - String eventName* - - - The type of event to listen for - - - Function handler - - - The handler to remove - - - Object scope - - - (optional) The scope (this object) for the handler - - - - - - - - - - - - - - - - -	- - Roo.util.Observable - -
	- - - updateBox - - (Object *box) - - - - - - - Sets the current box measurements of the component's underlying element. - - - - - - Sets the current box measurements of the component's underlying element. - - - - - - - - Parameters: - - - Object box* - - - An object in the format {x, y, width, height} - - - - - - - - - - - - - - - - -	- - Roo.BoxComponent - -
	- - - validate - - () - - - : - - - Boolean - - - - - - - - - Validates the combox array value - - - - - - Validates the combox array value - - - - - - - - - - - - Returns: - - Boolean True if the value is valid, else false - - - - - - - - - - - - -	- - Roo.form.ComboBoxArray - -
	- - - 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 - - - - - - - - Parameters: - - - Mixed value* - - - The value to validate - - - - - - - - - Returns: - - Boolean True if the value is valid, else false - - - - - - - - - - - - -	- - Roo.form.TextField - -

Events
Event		Defined By
	- - - - autosize (Roo.form.Field *this, Number width) - - - - - - Fires when the autosize function is triggered. - - - - - - Fires when the autosize function is triggered. The field may or may not have actually changed size according to the default logic, but this event provides a hook for the developer to apply additional logic at runtime to resize the field if needed. - - - - - - - Parameters: - - - Roo.form.Field this* - - - This text field - - - Number width - - - The new field width - - - - - - - - - - - - - - - - -	- Roo.form.TextField -
	- - - - beforedestroy (Roo.Component *this) - - - - - - Fires before the component is destroyed. - - - - - - Fires before the component is destroyed. Return false to stop the destroy. - - - - - - - Parameters: - - - Roo.Component this* - - - - - - - - - - - - - - - - - - - -	- Roo.Component -
	- - - - beforehide (Roo.Component *this) - - - - - - Fires before the component is hidden. - - - - - - Fires before the component is hidden. Return false to stop the hide. - - - - - - - Parameters: - - - Roo.Component this* - - - - - - - - - - - - - - - - - - - -	- Roo.Component -
	- - - - beforeremove (Roo.form.ComboBoxArray *_self, Roo.form.ComboBoxArray.Item item) - - - - - - Fires before remove the value from the list - - - - - - Fires before remove the value from the list - - - - - - - Parameters: - - - Roo.form.ComboBoxArray _self* - - - This combo box array - - - Roo.form.ComboBoxArray.Item item - - - removed item - - - - - - - - - - - - - - - - -	- Roo.form.ComboBoxArray -
	- - - - beforerender (Roo.Component *this) - - - - - - Fires before the component is rendered. - - - - - - Fires before the component is rendered. Return false to stop the render. - - - - - - - Parameters: - - - Roo.Component this* - - - - - - - - - - - - - - - - - - - -	- Roo.Component -
	- - - - beforeshow (Roo.Component *this) - - - - - - Fires before the component is shown. - - - - - - Fires before the component is shown. Return false to stop the show. - - - - - - - Parameters: - - - Roo.Component this* - - - - - - - - - - - - - - - - - - - -	- Roo.Component -
	- - - - blur (Roo.form.Field *this) - - - - - - Fires when this field loses input focus. - - - - - - Fires when this field loses input focus. - - - - - - - Parameters: - - - Roo.form.Field this* - - - - - - - - - - - - - - - - - - - -	- Roo.form.Field -
	- - - - change (Roo.form.Field *this, Mixed newValue, Mixed oldValue) - - - - - - Fires just before the field blurs if the field value has changed. - - - - - - Fires just before the field blurs if the field value has changed. - - - - - - - Parameters: - - - Roo.form.Field this* - - - - - - Mixed newValue - - - The new value - - - Mixed oldValue - - - The original value - - - - - - - - - - - - - - - - -	- Roo.form.Field -
	- - - - destroy (Roo.Component *this) - - - - - - Fires after the component is destroyed. - - - - - - Fires after the component is destroyed. - - - - - - - Parameters: - - - Roo.Component this* - - - - - - - - - - - - - - - - - - - -	- Roo.Component -
	- - - - disable (Roo.Component *this) - - - - - - Fires after the component is disabled. - - - - - - Fires after the component is disabled. - - - - - - - Parameters: - - - Roo.Component this* - - - - - - - - - - - - - - - - - - - -	- Roo.Component -
	- - - - enable (Roo.Component *this) - - - - - - Fires after the component is enabled. - - - - - - Fires after the component is enabled. - - - - - - - Parameters: - - - Roo.Component this* - - - - - - - - - - - - - - - - - - - -	- Roo.Component -
	- - - - focus (Roo.form.Field *this) - - - - - - Fires when this field receives input focus. - - - - - - Fires when this field receives input focus. - - - - - - - Parameters: - - - Roo.form.Field this* - - - - - - - - - - - - - - - - - - - -	- Roo.form.Field -
	- - - - hide (Roo.Component *this) - - - - - - Fires after the component is hidden. - - - - - - Fires after the component is hidden. - - - - - - - Parameters: - - - Roo.Component this* - - - - - - - - - - - - - - - - - - - -	- Roo.Component -
	- - - - 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. - - - - - - - Parameters: - - - Roo.form.Field this* - - - - - - String msg - - - The validation message - - - - - - - - - - - - - - - - -	- Roo.form.Field -
	- - - - keyup (Roo.form.Field *this, Roo.EventObject e) - - - - - - Fires after the key up - - - - - - Fires after the key up - - - - - - - Parameters: - - - Roo.form.Field this* - - - - - - Roo.EventObject e - - - The event Object - - - - - - - - - - - - - - - - -	- Roo.form.Field -
	- - - - move (Roo.Component *this, Number x, Number y) - - - - - - Fires after the component is moved. - - - - - - Fires after the component is moved. - - - - - - - Parameters: - - - Roo.Component this* - - - - - - Number x - - - The new x position - - - Number y - - - The new y position - - - - - - - - - - - - - - - - -	- Roo.BoxComponent -
	- - - - remove (Roo.form.ComboBoxArray *_self, Roo.form.ComboBoxArray.Item item) - - - - - - Fires when remove the value from the list - - - - - - Fires when remove the value from the list - - - - - - - Parameters: - - - Roo.form.ComboBoxArray _self* - - - This combo box array - - - Roo.form.ComboBoxArray.Item item - - - removed item - - - - - - - - - - - - - - - - -	- Roo.form.ComboBoxArray -
	- - - - render (Roo.Component *this) - - - - - - Fires after the component is rendered. - - - - - - Fires after the component is rendered. - - - - - - - Parameters: - - - Roo.Component this* - - - - - - - - - - - - - - - - - - - -	- Roo.Component -
	- - - - resize (Roo.Component *this, Number adjWidth, Number adjHeight, Number rawWidth, Number rawHeight) - - - - - - Fires after the component is resized. - - - - - - Fires after the component is resized. - - - - - - - Parameters: - - - Roo.Component this* - - - - - - Number adjWidth - - - The box-adjusted width that was set - - - Number adjHeight - - - The box-adjusted height that was set - - - Number rawWidth - - - The width that was originally specified - - - Number rawHeight - - - The height that was originally specified - - - - - - - - - - - - - - - - -	- Roo.BoxComponent -
	- - - - show (Roo.Component *this) - - - - - - Fires after the component is shown. - - - - - - Fires after the component is shown. - - - - - - - Parameters: - - - Roo.Component this* - - - - - - - - - - - - - - - - - - - -	- 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. - - - - - - - Parameters: - - - Roo.form.Field this - - - - - - Roo.EventObject e - - - The event object - - - - - - - - - - - - - - - - -	- Roo.form.Field -
	- - - - 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. - - - - - - - Parameters: - - - Roo.form.Field this* - - - - - - - - - - - - - - - - - - - -	- Roo.form.Field -

- - - - - - -

- - Documentation generated by Introspection Doc Generator on Fri Jul 13 2018 14:10:54 GMT+0800 (HKT) - Based on - JsDoc Toolkit -

- -