Overview

Packages

  • Actions
  • Codegen
  • Controls
    • Base
  • DatabaseAdapters
  • Events
  • None
  • Sessions
  • Tests

Classes

  • QAccordionBase
  • QAccordionGen
  • QAutocompleteBase
  • QAutocompleteGen
  • QDatepickerBase
  • QDatepickerBoxBase
  • QDatepickerBoxGen
  • QDatepickerGen
  • QDialogBase
  • QDialogGen
  • QDraggableBase
  • QDraggableGen
  • QDroppableBase
  • QDroppableGen
  • QFieldset
  • QJqButtonBase
  • QJqButtonGen
  • QJqCheckBoxBase
  • QJqCheckBoxGen
  • QJqRadioButtonBase
  • QJqRadioButtonGen
  • QMenuBase
  • QMenuGen
  • QProgressbarBase
  • QProgressbarGen
  • QResizableBase
  • QResizableGen
  • QSelectableBase
  • QSelectableGen
  • QSelectMenu
  • QSelectMenuBase
  • QSelectMenuGen
  • QSliderBase
  • QSliderGen
  • QSortableBase
  • QSortableGen
  • QSpinnerBase
  • QSpinnerGen
  • QTabsBase
  • QTabsGen
  • QTextBoxBase
  • Overview
  • Package
  • Class

Class QAutocompleteGen

Generated QAutocompleteGen class.

This is the QAutocompleteGen class which is automatically generated by scraping the JQuery UI documentation website. As such, it includes all the options as listed by the JQuery UI website, which may or may not be appropriate for QCubed. See the QAutocompleteBase class for any glue code to make this class more usable in QCubed.

QBaseClass
Extended by QHtmlAttributeManagerBase
Extended by QHtmlAttributeManager
Extended by QControlBase
Extended by QControl
Extended by QTextBoxBase
Extended by QTextBox
Extended by QAutocompleteGen

Direct known subclasses

QAutocompleteBase

Indirect known subclasses

QAutocomplete
Package: Controls\Base
See: QAutocompleteBase
Located at includes/base_controls/QAutocompleteGen.class.php
Methods summary
protected array
# MakeJqOptions( )

Builds the option array to be sent to the widget constructor.

Builds the option array to be sent to the widget constructor.

Returns

array
key=>value array of options
public string
# GetJqSetupFunction( )

Return the JavaScript function to call to associate the widget with the control.

Return the JavaScript function to call to associate the widget with the control.

Returns

string
public string
# GetEndScript( )

Returns the script that attaches the JQueryUI widget to the html object.

Returns the script that attaches the JQueryUI widget to the html object.

Returns

string

Overrides

QControlBase::GetEndScript()
public
# Close( )

Closes the Autocomplete menu. Useful in combination with the search method, to close the open menu.

Closes the Autocomplete menu. Useful in combination with the search method, to close the open menu.

  • This method does not accept any arguments.
public
# Destroy( )

Removes the autocomplete functionality completely. This will return the element back to its pre-init state.

Removes the autocomplete functionality completely. This will return the element back to its pre-init state.

  • This method does not accept any arguments.
public
# Disable( )

Disables the autocomplete.

Disables the autocomplete.

  • This method does not accept any arguments.
public
# Enable( )

Enables the autocomplete.

Enables the autocomplete.

  • This method does not accept any arguments.
public
# Instance( )

Retrieves the autocompletes instance object. If the element does not have an associated instance, undefined is returned.

Retrieves the autocompletes instance object. If the element does not have an associated instance, undefined is returned.

Unlike other widget methods, instance() is safe to call on any element after the autocomplete plugin has loaded. * This method does not accept any arguments.

public
# Option( $optionName )

Gets the value currently associated with the specified optionName.

Gets the value currently associated with the specified optionName.

Note: For options that have objects as their value, you can get the value of a specific key by using dot notation. For example, "foo.bar" would get the value of the bar property on the foo option. * optionName Type: String The name of the option to get.

Parameters

$optionName
public
# Option1( )

Gets an object containing key/value pairs representing the current autocomplete options hash.

Gets an object containing key/value pairs representing the current autocomplete options hash.

  • This signature does not accept any arguments.
public
# Option2( $optionName, $value )

Sets the value of the autocomplete option associated with the specified optionName.

Sets the value of the autocomplete option associated with the specified optionName.

Note: For options that have objects as their value, you can set the value of just one property by using dot notation for optionName. For example, "foo.bar" would update only the bar property of the foo option. * optionName Type: String The name of the option to set. * value Type: Object A value to set for the option.

Parameters

$optionName
$value
public
# Option3( $options )

Sets one or more options for the autocomplete.

Sets one or more options for the autocomplete.

  • options Type: Object A map of option-value pairs to set.

Parameters

$options
public
# Search( $value = null )

Triggers a search event and invokes the data source if the event is not canceled. Can be used by a selectbox-like button to open the suggestions when clicked. When invoked with no parameters, the current inputs value is used. Can be called with an empty string and minLength: 0 to display all items.

Triggers a search event and invokes the data source if the event is not canceled. Can be used by a selectbox-like button to open the suggestions when clicked. When invoked with no parameters, the current inputs value is used. Can be called with an empty string and minLength: 0 to display all items.

  • value Type: String

Parameters

$value
public array|boolean|integer|mixed|null|QControl|QForm|string
# __get( string $strName )

PHP __get magic method implementation

PHP __get magic method implementation

Parameters

$strName
Name of the property

Returns

array|boolean|integer|mixed|null|QControl|QForm|string

Throws

Exception|QCallerException

Overrides

QTextBoxBase::__get()
public mixed
# __set( string $strName, string $mixValue )

PHP __set magic method implementation

PHP __set magic method implementation

Parameters

$strName
Name of the property
$mixValue
Value of the property

Returns

mixed

Throws

Exception|QCallerException|QInvalidCastException

Overrides

QTextBoxBase::__set()
public static QModelConnectorParam[]
# GetModelConnectorParams( )

If this control is attachable to a codegenerated control in a ModelConnector, this function will be used by the ModelConnector designer dialog to display a list of options for the control.

If this control is attachable to a codegenerated control in a ModelConnector, this function will be used by the ModelConnector designer dialog to display a list of options for the control.

Returns

QModelConnectorParam[]

Overrides

QTextBoxBase::GetModelConnectorParams()
Methods inherited from QTextBoxBase
GetControlHtml(), GetState(), InitHtmlPurifier(), ParsePostData(), PutState(), RenderHtmlAttributes(), Sanitize(), Select(), SetPurifierConfig(), Validate(), __construct()
Methods inherited from QControlBase
AddAction(), AddActionArray(), AddAttributeScript(), AddChildControl(), AddCssFile(), AddJavascriptFile(), AddPluginCssFile(), AddPluginJavascriptFile(), AddWrapperCssClass(), Blink(), EvaluateTemplate(), Focus(), ForgetState(), GetAllActions(), GetAttributes(), GetChildControl(), GetChildControls(), GetControlFromHierarchyByMethodName(), GetCustomAttribute(), GetCustomAttributes(), GetCustomStyle(), GetEndHtml(), GetForm(), GetJavaScriptForEvent(), GetJqControlId(), GetNonWrappedHtml(), GetStyleAttributes(), GetTemplatePath(), GetWrapperAttributes(), GetWrapperStyleAttributes(), GetWrapperStyler(), IsDescendantOf(), IsModified(), MakeCurrent(), MarkAsModified(), MarkAsRendered(), MarkAsWrapperModified(), ProcessActionParameters(), Refresh(), RemoveAllActions(), RemoveChildControl(), RemoveChildControls(), RemoveCustomAttribute(), RemoveCustomStyle(), RemoveWrapperCssClass(), Render(), RenderActionScripts(), RenderAjax(), RenderAttributeScripts(), RenderChildren(), RenderComment(), RenderCssStyles(), RenderExtensionRenderer(), RenderHelper(), RenderOutput(), RenderWithError(), RenderWithName(), RenderWrappedOutput(), ResetFlags(), ResetOnPageStatus(), SetCustomAttribute(), SetCustomStyle(), SetFocus(), SetForm(), SetParentControl(), Sleep(), SleepHelper(), ValidateControlAndChildren(), ValidationReset(), VarExport(), Wakeup(), WakeupHelper(), Watch(), _CallActionMethod(), _ProcessActionParams(), _ReadState(), _WriteState()
Methods inherited from QHtmlAttributeManagerBase
AddCssClass(), GetCssStyle(), GetDataAttribute(), GetHtmlAttribute(), GetHtmlAttributes(), HasCssClass(), HasCssStyle(), HasHtmlAttribute(), Override(), RemoveCssClass(), RemoveCssClassesByPrefix(), RemoveCssStyle(), RemoveDataAttribute(), RemoveHtmlAttribute(), RenderTag(), SetCssBoxValue(), SetCssClass(), SetCssStyle(), SetDataAttribute(), SetHtmlAttribute()
Methods inherited from QBaseClass
OverrideAttributes(), __call()
Constants inherited from QControlBase
CommentEnd, CommentStart
Properties summary
protected string $strJavaScripts

List of JavaScript files to be attached with the control when rendering

List of JavaScript files to be attached with the control when rendering

# __JQUERY_EFFECTS__
protected string $strStyleSheets

List of CSS files to be attaches with the control when rendering

List of CSS files to be attaches with the control when rendering

# __JQUERY_CSS__
protected mixed $mixAppendTo
# null
protected boolean $blnAutoFocus
# null
protected integer $intDelay
# null
protected boolean $blnDisabled
# null
protected integer $intMinLength
# null
protected mixed $mixPosition
# null
protected mixed $mixSource
#
Properties inherited from QTextBox
$strCssClass
Properties inherited from QTextBoxBase
$blnAutoTrim, $intColumns, $intMaxLength, $intRows, $intSanitizeFilter, $intValidateFilter, $mixSanitizeFilterOptions, $mixValidateFilterOptions, $objHTMLPurifierConfig, $strCrossScripting, $strFormat, $strLabelForInvalid, $strLabelForRequired, $strLabelForRequiredUnnamed, $strLabelForTooLong, $strLabelForTooLongUnnamed, $strLabelForTooShort, $strLabelForTooShortUnnamed, $strPlaceholder, $strText, $strTextMode
Properties inherited from QControlBase
$blnActionsMustTerminate, $blnAutoRender, $blnDisplay, $blnIsBlockElement, $blnMinimize, $blnModified, $blnOnPage, $blnRendered, $blnRendering, $blnRequired, $blnSaveState, $blnScriptsOnly, $blnUseWrapper, $blnVisible, $blnWrapLabel, $blnWrapperModified, $mixActionParameter, $mixCausesValidation, $objActionArray, $objChildControlArray, $objDraggable, $objDroppable, $objForm, $objLinkedNode, $objParentControl, $objResizable, $objWatcher, $objWrapperStyler, $strAttributeScripts, $strControlId, $strCustomAttributeArray, $strCustomStyleArray, $strFormAttributes, $strHtmlAfter, $strHtmlBefore, $strInstructions, $strName, $strPreferredRenderMethod, $strRenderMethod, $strValidationError, $strWarning
Properties inherited from QHtmlAttributeManagerBase
$attributes, $styles
Magic properties summary
public mixed $AppendTo

Which element the menu should be appended to. When the value is null, the parents of the input field will be checked for a class of ui-front. If an element with the ui-front class is found, the menu will be appended to that element. Regardless of the value, if no element is found, the menu will be appended to the body. Note: The appendTo option should not be changed while the suggestions menu is open.

public boolean $AutoFocus

If set to true the first item will automatically be focused when the menu is shown.

public integer $Delay

The delay in milliseconds between when a keystroke occurs and when a search is performed. A zero-delay makes sense for local data (more responsive), but can produce a lot of load for remote data, while being less responsive.

public boolean $Disabled

Disables the autocomplete if set to true.

public integer $MinLength

The minimum number of characters a user must type before a search is performed. Zero is useful for local data with just a few items, but a higher value should be used when a single character search could match a few thousand items.

public mixed $Position

Identifies the position of the suggestions menu in relation to the associated input element. The of option defaults to the input element, but you can specify another element to position against. You can refer to the jQuery UI Position utility for more details about the various options.

public mixed $Source

Defines the data to use, must be specified. Independent of the variant you use, the label is always treated as text. If you want the label to be treated as html you can use Scott González html extension. The demos all focus on different variations of the source option - look for one that matches your use case, and check out the code.Multiple types supported: * Array: An array can be used for local data. There are two supported formats: * An array of strings: [ "Choice1", "Choice2" ] * An array of objects with label and value properties: [ { label: "Choice1", value: "value1" }, ... ] The label property is displayed in the suggestion menu. The value will be inserted into the input element when a user selects an item. If just one property is specified, it will be used for both, e.g., if you provide only value properties, the value will also be used as the label. * String: When a string is used, the Autocomplete plugin expects that string to point to a URL resource that will return JSON data. It can be on the same host or on a different one (must provide JSONP). The Autocomplete plugin does not filter the results, instead a query string is added with a term field, which the server-side script should use for filtering the results. For example, if the source option is set to "http://example.com" and the user types foo, a GET request would be made to http://example.com?term=foo. The data itself can be in the same format as the local data described above. * Function: The third variation, a callback, provides the most flexibility and can be used to connect any data source to Autocomplete. The callback gets two arguments: * A request object, with a single term property, which refers to the value currently in the text input. For example, if the user enters "new yo" in a city field, the Autocomplete term will equal "new yo". * A response callback, which expects a single argument: the data to suggest to the user. This data should be filtered based on the provided term, and can be in any of the formats described above for simple local data. Its important when providing a custom source callback to handle errors during the request. You must always call the response callback even if you encounter an error. This ensures that the widget always has the correct state. When filtering data locally, you can make use of the built-in $.ui.autocomplete.escapeRegex function. Itll take a single string argument and escape all regex characters, making the result safe to pass to new RegExp().

Magic properties inherited from QTextBoxBase
$AutoTrim, $Columns, $CrossScripting, $Format, $LabelForInvalid, $LabelForRequired, $LabelForRequiredUnnamed, $LabelForTooLong, $LabelForTooLongUnnamed, $LabelForTooShort, $LabelForTooShortUnnamed, $MaxLength, $Placeholder, $Rows, $SanitizeFilter, $SanitizeFilterOptions, $Text, $TextMode, $ValidateFilter, $ValidateFilterOptions, $Value
Magic properties inherited from QControlBase
$ActionParameter, $ActionsMustTerminate, $AutoRender, $CausesValidation, $ControlId, $Form, $FormAttributes, $HtmlAfter, $HtmlBefore, $Instructions, $JavaScripts, $LinkedNode, $Minimize, $Modified, $Moveable, $Name, $OnPage, $ParentControl, $PreferredRenderMethod, $RenderMethod, $Rendered, $Rendering, $Required, $Resizable, $SaveState, $ScriptsOnly, $StyleSheets, $UseWrapper, $ValidationError, $Visible, $Warning, $WrapLabel, $WrapperCssClass, $WrapperModified
Magic properties inherited from QHtmlAttributeManagerBase
$AccessKey, $AltText, $BackColor, $BorderCollapse, $BorderColor, $BorderStyle, $BorderWidth, $CssClass, $Cursor, $Data, $Display, $DisplayStyle, $Enabled, $FontBold, $FontItalic, $FontNames, $FontOverline, $FontSize, $FontStrikeout, $FontUnderline, $ForeColor, $Height, $HorizontalAlign, $Left, $Margin, $NoWrap, $Opacity, $OrderedListType, $Overflow, $Padding, $ReadOnly, $TabIndex, $ToolTip, $Top, $UnorderedListStyle, $VerticalAlign, $Width
API documentation generated by ApiGen