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 TDraggable

TDraggable is a control which can be dragged

This control will make "draggable" control. Properties :

setGhosting Ghosting : If set to "Ghosting" or "True", the dragged element will be cloned, and the clone will be dragged. If set to "SuperGhosting", the element will be cloned, and attached to body, so it can be dragged outside of its parent. If set to "None" of "False" (default), the element itself is dragged setRevert Revert: Set to True if you want your dragged element to revert to its initial position if not dropped on a valid area. setConstraint Constraint: Set this to Horizontal or Vertical if you want to constraint your move in one direction. setHandle Handle:

TComponent
Extended by TApplicationComponent
Extended by TControl implements IRenderable, IBindable
Extended by TWebControl implements IStyleable
Extended by TPanel
Extended by TDraggable
Package: System\Web\UI\ActiveControls
Copyright: Copyright © 2008, PradoSoft
License: http://www.pradosoft.com/license
Author: Christophe BOULAIN (Christophe.Boulain@gmail.com)
Located at Web/UI/ActiveControls/TDraggable.php
Methods summary
public
# setHandle( string $value )

Set the handle id or css class

Set the handle id or css class

Parameters

$value
string
public string
# getHandle( )

Get the handle id or css class

Get the handle id or css class

Returns

string
public TDraggableRevertOption
# getRevert( )

Determine if draggable element should revert to it orginal position upon release in an non-droppable container. Since 3.2, Revert property can be set to one of the value of TDraggableRevertOption enumeration.
o 'True' or 'Revert' : The draggable will revert to it's original position
o 'False' or 'None' : The draggable won't revert to it's original position
o 'Failure' : The draggable will only revert if it's dropped on a non droppable area

Determine if draggable element should revert to it orginal position upon release in an non-droppable container. Since 3.2, Revert property can be set to one of the value of TDraggableRevertOption enumeration. o 'True' or 'Revert' : The draggable will revert to it's original position o 'False' or 'None' : The draggable won't revert to it's original position o 'Failure' : The draggable will only revert if it's dropped on a non droppable area

Returns

TDraggableRevertOption
true to revert
public
# setRevert( boolean $value )

Sets whether the draggable element should revert to it orginal position upon release in an non-droppable container. Since 3.2, Revert property can be set to one of the value of TDraggableRevertOption enumeration.
o 'True' or 'Revert' : The draggable will revert to it's original position
o 'False' or 'None' : The draggable won't revert to it's original position
o 'Failure' : The draggable will only revert if it's dropped on a non droppable area

Sets whether the draggable element should revert to it orginal position upon release in an non-droppable container. Since 3.2, Revert property can be set to one of the value of TDraggableRevertOption enumeration. o 'True' or 'Revert' : The draggable will revert to it's original position o 'False' or 'None' : The draggable won't revert to it's original position o 'Failure' : The draggable will only revert if it's dropped on a non droppable area

Parameters

$value
boolean
true to revert
public TDraggableGhostingOption
# getGhosting( )

Determine if the element should be cloned when dragged If true, Clones the element and drags the clone, leaving the original in place until the clone is dropped. Defaults to false
Since 3.2, Ghosting can be set to one of the value of TDraggableGhostingOptions enumeration.
o "True" or "Ghosting" means standard pre-3.2 ghosting mechanism
o "SuperGhosting" use the Superghosting patch by Christopher Williams, which allow elements to be dragged from an
scrollable list
o "False" or "None" means no Ghosting options

Determine if the element should be cloned when dragged If true, Clones the element and drags the clone, leaving the original in place until the clone is dropped. Defaults to false Since 3.2, Ghosting can be set to one of the value of TDraggableGhostingOptions enumeration. o "True" or "Ghosting" means standard pre-3.2 ghosting mechanism o "SuperGhosting" use the Superghosting patch by Christopher Williams, which allow elements to be dragged from an scrollable list o "False" or "None" means no Ghosting options

Returns

TDraggableGhostingOption
to clone the element
public
# setGhosting( mixed $value )

Sets wether the element should be cloned when dragged If true, Clones the element and drags the clone, leaving the original in place until the clone is dropped. Defaults to false

Sets wether the element should be cloned when dragged If true, Clones the element and drags the clone, leaving the original in place until the clone is dropped. Defaults to false

Since 3.2, Ghosting can be set to one of the value of TDraggableGhostingOptions enumeration. o "True" or "Ghosting" means standard pre-3.2 ghosting mechanism o "SuperGhosting" use the Superghosting patch by Christopher Williams, which allow elements to be dragged from an scrollable list o "False" or "None" means no Ghosting options

public CDraggableConstraint
# getConstraint( )

Determine if the element should be constrainted in one direction or not

Determine if the element should be constrainted in one direction or not

Returns

CDraggableConstraint
public
# setConstraint( CDraggableConstraint $value )

Set wether the element should be constrainted in one direction

Set wether the element should be constrainted in one direction

Parameters

$value
CDraggableConstraint
public
# onPreRender( mixed $param )

Registers clientscripts

Registers clientscripts

This method overrides the parent implementation and is invoked before render.

Parameters

$param
mixed
event parameter

Overrides

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

Ensure that the ID attribute is rendered and registers the javascript code for initializing the active control.

Ensure that the ID attribute is rendered and registers the javascript code for initializing the active control.

Parameters

$writer
THtmlWriter
the renderer

Throws

TInvalidDataValueException
if default button is not right.

Overrides

TPanel::addAttributesToRender()
protected string
# getClientClassName( )

Gets the name of the javascript class responsible for performing postback for this control. This method overrides the parent implementation.

Gets the name of the javascript class responsible for performing postback for this control. This method overrides the parent implementation.

Returns

string
the javascript class name
protected array
# getPostBackOptions( )

Gets the post back options for this textbox.

Gets the post back options for this textbox.

Returns

array
Methods inherited from TPanel
createStyle(), getBackImageUrl(), getDefaultButton(), getDirection(), getGroupingText(), getHorizontalAlign(), getScrollBars(), getTagName(), getWrap(), render(), renderBeginTag(), renderEndTag(), setBackImageUrl(), setDefaultButton(), setDirection(), setGroupingText(), setHorizontalAlign(), setScrollBars(), setWrap()
Methods inherited from TWebControl
clearStyle(), copyBaseAttributes(), getAccessKey(), getBackColor(), getBorderColor(), getBorderStyle(), getBorderWidth(), getCssClass(), getDecorator(), getDisplay(), getEnsureId(), getFont(), getForeColor(), getHasStyle(), getHeight(), getStyle(), getTabIndex(), getToolTip(), getWidth(), renderContents(), 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