PRADO Component Framework for PHP 5
  • Home
  • About
  • Testimonials
  • Demos
  • Download
  • Documentation
  • Forum
  • Development
  • Tutorials
  • Class Docs
  • API Manual
  • Wiki

Packages

  • None
  • System
    • Caching
    • Collections
    • Data
      • ActiveRecord
        • Relations
        • Scaffold
          • InputBuilder
      • Commom
        • Sqlite
      • Common
        • Mssql
        • Mysql
        • Oracle
        • Pgsql
        • Sqlite
      • DataGateway
      • SqlMap
        • Configuration
        • Statements
    • Exceptions
    • I18N
    • IO
    • Security
    • Util
    • Web
      • Javascripts
      • Services
      • UI
        • ActiveControls
        • WebControls
    • Xml
  • Wsat
    • pages
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class TKeyboard

Class 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:

<com:TTextBox ID="PasswordInput" />
<com:TKeyboard ForControl="PasswordInput" />

A TKeyboard control is associated with a TTextBox control by specifying 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 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 setCssUrl CssUrl. By default, the CSS class name for the keyboard is 'Keyboard'. This may also be changed by specifying setKeyboardCssClass KeyboardCssClass.

TComponent
Extended by TApplicationComponent
Extended by TControl implements IRenderable, IBindable
Extended by TWebControl implements IStyleable
Extended by TKeyboard
Package: System\Web\UI\WebControls
Copyright: Copyright © 2005-2014 PradoSoft
License: http://www.pradosoft.com/license/
Author: Sergey Morkovkin <sergeymorkovkin@mail.ru> and Qiang Xue <qiang.xue@gmail.com>
Since: 3.1.1
Located at Web/UI/WebControls/TKeyboard.php
Methods summary
public string
# getForControl( )

Returns

string
the ID path of the TTextBox control
public
# setForControl( string $value )

Sets the ID path of the TTextBox control. The ID path is the dot-connected IDs of the controls reaching from the keyboard's naming container to the target control.

Sets the ID path of the TTextBox control. The ID path is the dot-connected IDs of the controls reaching from the keyboard's naming container to the target control.

Parameters

$value
string
the ID path
public boolean
# getAutoHide( )

Returns

boolean
whether the keyboard should be hidden when the textbox is not in focus. Defaults to true.
public
# setAutoHide( boolean $value )

Parameters

$value
boolean
whether the keyboard should be hidden when the textbox is not in focus.
public string
# getKeyboardCssClass( )

Returns

string
the CSS class name for the keyboard <div> element. Defaults to 'Keyboard'.
public
# setKeyboardCssClass( string $value )

Sets a value indicating the CSS class name for the keyboard <div> element. Note, if you change this property, make sure you also supply a customized CSS file by specifying setCssUrl CssUrl which uses the new CSS class name for styling.

Sets a value indicating the CSS class name for the keyboard <div> element. Note, if you change this property, make sure you also supply a customized CSS file by specifying setCssUrl CssUrl which uses the new CSS class name for styling.

Parameters

$value
string
the CSS class name for the keyboard <div> element.
public string
# getCssUrl( )

Returns

string
the URL for the CSS file to customize the appearance of the keyboard.
public
# setCssUrl( string $value )

Parameters

$value
string
the URL for the CSS file to customize the appearance of the keyboard.
public
# onPreRender( mixed $param )

Registers CSS and JS. This method is invoked right before the control rendering, if the control is visible.

Registers CSS and JS. This method is invoked right before the control rendering, if the control is visible.

Parameters

$param
mixed
event parameter

Overrides

TWebControl::onPreRender()
protected
# addAttributesToRender( THtmlWriter $writer )

Adds attribute name-value pairs to renderer. This method overrides the parent implementation with additional TKeyboard specific attributes.

Adds attribute name-value pairs to renderer. This method overrides the parent implementation with additional TKeyboard specific attributes.

Parameters

$writer
THtmlWriter
the writer used for the rendering purpose

Overrides

TWebControl::addAttributesToRender()
protected
# registerStyleSheet( )

Registers the CSS relevant to the TKeyboard. It will register the CSS file specified by getCssUrl CssUrl. If that is not set, it will use the default CSS.

Registers the CSS relevant to the TKeyboard. It will register the CSS file specified by getCssUrl CssUrl. If that is not set, it will use the default CSS.

protected
# registerClientScript( )

Registers the relevant JavaScript.

Registers the relevant JavaScript.

protected string
# getClientClassName( )

Returns

string
the Javascript class name for this control
protected array
# getClientOptions( )

Returns

array
the JavaScript options for this control
Methods inherited from TWebControl
clearStyle(), copyBaseAttributes(), createStyle(), getAccessKey(), getBackColor(), getBorderColor(), getBorderStyle(), getBorderWidth(), getCssClass(), getDecorator(), getDisplay(), getEnsureId(), getFont(), getForeColor(), getHasStyle(), getHeight(), getStyle(), getTabIndex(), getTagName(), getToolTip(), getWidth(), render(), renderBeginTag(), renderContents(), renderEndTag(), setAccessKey(), setBackColor(), setBorderColor(), setBorderStyle(), setBorderWidth(), setCssClass(), setDisplay(), setEnsureId(), setForeColor(), setHeight(), setStyle(), setTabIndex(), setToolTip(), setWidth()
Methods inherited from TControl
__construct(), __get(), addParsedObject(), addToPostDataLoader(), addedControl(), applyStyleSheetSkin(), autoBindProperty(), autoDataBindProperties(), bindProperty(), broadcastEvent(), bubbleEvent(), clearChildState(), clearControlState(), clearNamingContainer(), clearViewState(), convertUniqueIdToClientId(), createChildControls(), createControlCollection(), dataBind(), dataBindChildren(), dataBindProperties(), ensureChildControls(), findControl(), findControlsByID(), findControlsByType(), focus(), getAdapter(), getAllowChildControls(), getAttribute(), getAttributes(), getChildControlsCreated(), getClientID(), getControlStage(), getControlState(), getControls(), getCustomData(), getEnableTheming(), getEnableViewState(), getEnabled(), getHasAdapter(), getHasAttributes(), getHasChildInitialized(), getHasControls(), getHasInitialized(), getHasLoaded(), getHasLoadedPostData(), getHasPreRendered(), getID(), getIsSkinApplied(), getNamingContainer(), getPage(), getParent(), getRegisteredObject(), getSkinID(), getSourceTemplateControl(), getTemplateControl(), getUniqueID(), getViewState(), getVisible(), hasAttribute(), initRecursive(), isDescendentOf(), isObjectRegistered(), loadRecursive(), loadState(), loadStateRecursive(), onDataBinding(), onInit(), onLoad(), onUnload(), preRenderRecursive(), raiseBubbleEvent(), registerObject(), removeAttribute(), removedControl(), renderChildren(), renderControl(), saveState(), saveStateRecursive(), setAdapter(), setAttribute(), setChildControlsCreated(), setControlStage(), setControlState(), setCustomData(), setEnableTheming(), setEnableViewState(), setEnabled(), setID(), setPage(), setSkinID(), setTemplateControl(), setViewState(), setVisible(), trackViewState(), traverseChildControls(), unbindProperty(), unloadRecursive(), unregisterObject()
Methods inherited from TApplicationComponent
getApplication(), getRequest(), getResponse(), getService(), getSession(), getUser(), publishAsset(), publishFilePath()
Methods inherited from TComponent
__call(), __destruct(), __isset(), __set(), __sleep(), __unset(), __wakeup(), asa(), attachBehavior(), attachBehaviors(), attachClassBehavior(), attachEventHandler(), canGetProperty(), canSetProperty(), clearBehaviors(), createdOnTemplate(), detachBehavior(), detachBehaviors(), detachClassBehavior(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), evaluateStatements(), fxAttachClassBehavior(), fxDetachClassBehavior(), getAutoGlobalListen(), getBehaviorsEnabled(), getClassHierarchy(), getEventHandlers(), getListeningToGlobalEvents(), getSubProperty(), hasEvent(), hasEventHandler(), hasProperty(), isa(), listen(), raiseEvent(), setSubProperty(), unlisten()
Constants inherited from TControl
AUTOMATIC_ID_PREFIX, CLIENT_ID_SEPARATOR, CS_CHILD_INITIALIZED, CS_CONSTRUCTED, CS_INITIALIZED, CS_LOADED, CS_PRERENDERED, CS_STATE_LOADED, ID_FORMAT, ID_SEPARATOR, IS_CHILD_CREATED, IS_CREATING_CHILD, IS_DISABLE_THEMING, IS_DISABLE_VIEWSTATE, IS_ID_SET, IS_SKIN_APPLIED, IS_STYLESHEET_APPLIED, RF_ADAPTER, RF_AUTO_BINDINGS, RF_CHILD_STATE, RF_CONTROLS, RF_CONTROLSTATE, RF_DATA_BINDINGS, RF_EVENTS, RF_NAMED_CONTROLS, RF_NAMED_CONTROLS_ID, RF_NAMED_OBJECTS, RF_SKIN_ID
Constants inherited from TComponent
GLOBAL_RAISE_EVENT_LISTENER
Properties inherited from TWebControl
$_decorator
Terms of Service | Contact Us
PRADO v3.2.4 API Manual API documentation generated by ApiGen 2.8.0
Copyright © 2006-2014 by the PRADO Group.
Powered by PRADO