PHP Класс Prado\Web\UI\WebControls\TKeyboard

TKeyboard displays a virtual keyboard that users can click on to enter input in an associated text box. It helps to reduce the keyboard recording hacking. To use TKeyboard, write a template like following: A TKeyboard control is associated with a {@link TTextBox} control by specifying {@link setForControl ForControl} to be the ID of that control. When the textbox is in focus, a virtual keyboard will pop up; and when the text box is losing focus, the keyboard will hide automatically. Set {@link setAutoHide AutoHide} to false to keep the keyboard showing all the time. The appearance of the keyboard can also be changed by specifying a customized CSS file via {@link setCssUrl CssUrl}. By default, the CSS class name for the keyboard is 'Keyboard'. This may also be changed by specifying {@link setKeyboardCssClass KeyboardCssClass}.
С версии: 3.1.1
Наследование: extends TWebControl
Показать файл Открыть проект

Открытые методы

Метод Описание
getAutoHide ( ) : boolean
getCssUrl ( ) : string
getForControl ( ) : string
getKeyboardCssClass ( ) : string
onPreRender ( $param ) Registers CSS and JS.
setAutoHide ( $value )
setCssUrl ( $value )
setForControl ( $value ) Sets the ID path of the {@link TTextBox} control.
setKeyboardCssClass ( $value ) Sets a value indicating the CSS class name for the keyboard
element.

Защищенные методы

Метод Описание
addAttributesToRender ( $writer ) Adds attribute name-value pairs to renderer.
getClientClassName ( ) : string
getClientOptions ( ) : array
registerClientScript ( ) Registers the relevant JavaScript.
registerStyleSheet ( ) Registers the CSS relevant to the TKeyboard.

Описание методов

addAttributesToRender() защищенный Метод

This method overrides the parent implementation with additional TKeyboard specific attributes.
protected addAttributesToRender ( $writer )

getAutoHide() публичный Метод

public getAutoHide ( ) : boolean
Результат boolean whether the keyboard should be hidden when the textbox is not in focus. Defaults to true.

getClientClassName() защищенный Метод

protected getClientClassName ( ) : string
Результат string the Javascript class name for this control

getClientOptions() защищенный Метод

protected getClientOptions ( ) : array
Результат array the JavaScript options for this control

getCssUrl() публичный Метод

public getCssUrl ( ) : string
Результат string the URL for the CSS file to customize the appearance of the keyboard.

getForControl() публичный Метод

public getForControl ( ) : string
Результат string the ID path of the {@link TTextBox} control

getKeyboardCssClass() публичный Метод

public getKeyboardCssClass ( ) : string
Результат string the CSS class name for the keyboard
element. Defaults to 'Keyboard'.

onPreRender() публичный Метод

This method is invoked right before the control rendering, if the control is visible.
public onPreRender ( $param )

registerClientScript() защищенный Метод

Registers the relevant JavaScript.
protected registerClientScript ( )

registerStyleSheet() защищенный Метод

It will register the CSS file specified by {@link getCssUrl CssUrl}. If that is not set, it will use the default CSS.
protected registerStyleSheet ( )

setAutoHide() публичный Метод

public setAutoHide ( $value )

setCssUrl() публичный Метод

public setCssUrl ( $value )

setForControl() публичный Метод

The ID path is the dot-connected IDs of the controls reaching from the keyboard's naming container to the target control.
public setForControl ( $value )

setKeyboardCssClass() публичный Метод

Note, if you change this property, make sure you also supply a customized CSS file by specifying {@link setCssUrl CssUrl} which uses the new CSS class name for styling.
public setKeyboardCssClass ( $value )