PHP Class 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}.

Since: 3.1.1

Inheritance: extends TWebControl

Mostra file Open project: pradosoft/prado

Public Methods

Method	Description
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.

Protected Methods

Method	Description
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.

Method Details

addAttributesToRender() protected method

This method overrides the parent implementation with additional TKeyboard specific attributes.

protected addAttributesToRender ( $writer )

getAutoHide() public method

public getAutoHide ( ) : boolean
return	boolean	whether the keyboard should be hidden when the textbox is not in focus. Defaults to true.

getClientClassName() protected method

protected getClientClassName ( ) : string
return	string	the Javascript class name for this control

getClientOptions() protected method

protected getClientOptions ( ) : array
return	array	the JavaScript options for this control

getCssUrl() public method

public getCssUrl ( ) : string
return	string	the URL for the CSS file to customize the appearance of the keyboard.

getForControl() public method

public getForControl ( ) : string
return	string	the ID path of the {@link TTextBox} control

getKeyboardCssClass() public method

public getKeyboardCssClass ( ) : string
return	string	the CSS class name for the keyboard element. Defaults to 'Keyboard'.

onPreRender() public method

This method is invoked right before the control rendering, if the control is visible.

public onPreRender ( $param )

registerClientScript() protected method

Registers the relevant JavaScript.

protected registerClientScript ( )

registerStyleSheet() protected method

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 method

public setAutoHide ( $value )

setCssUrl() public method

public setCssUrl ( $value )

setForControl() public method

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() public method

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 )