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 TDropContainer

TDropContainer is a panel where TDraggable controls can be dropped. When a TDraggable component is dropped into a TDropContainer, the OnDrop OnDrop event is raised. The TDropContainerEventParameter param will contain the dropped control.

Properties :

setAcceptCssClass AcceptCssClass : a coma delimited classname of elements that the drop container can accept. setHoverCssClass HoverCssClass: CSS classname of the container when a draggable element hovers over the container.

Events:

OnDrop OnDrop : raised when a TDraggable control is dropped. The dropped control id is encapsulated in the event parameter, as well as mouse coordinates and key modifiers status

TComponent
Extended by TApplicationComponent
Extended by TControl implements IRenderable, IBindable
Extended by TWebControl implements IStyleable
Extended by TPanel
Extended by TDropContainer implements IActiveControl, ICallbackEventHandler
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/TDropContainer.php
Methods summary
public
# __construct( )

Creates a new callback control, sets the adapter to TActiveControlAdapter. If you override this class, be sure to set the adapter appropriately by, for example, by calling this constructor.

Creates a new callback control, sets the adapter to TActiveControlAdapter. If you override this class, be sure to set the adapter appropriately by, for example, by calling this constructor.

Overrides

TControl::__construct()
public TBaseActiveControl
# getActiveControl( )

Returns

TBaseActiveControl
standard active control options.

Implementation of

IActiveControl::getActiveControl()
public TCallbackClientSide
# getClientSide( )

Returns

TCallbackClientSide
client side request options.
public string
# getAcceptCssClass( )

Gets the Css class name that this container can accept.

Gets the Css class name that this container can accept.

Returns

string
public
# setAcceptCssClass( string $value )

Sets the Css class name that this container can accept.

Sets the Css class name that this container can accept.

Parameters

$value
string
comma delimited css class names.
public
# setHoverCssClass( string $value )

Sets the Css class name used when a draggble element is hovering over this container.

Sets the Css class name used when a draggble element is hovering over this container.

Parameters

$value
string
css class name during draggable hover.
public string
# getHoverCssClass( )

Gets the Css class name used when a draggble element is hovering over this container.

Gets the Css class name used when a draggble element is hovering over this container.

Returns

string
css class name during draggable hover.
public
# raiseCallbackEvent( TCallbackEventParameter $param )

Raises callback event. This method is required bu ICallbackEventHandler interface. It raises the onDrop OnDrop event, then, the onCallback OnCallback event This method is mainly used by framework and control developers.

Raises callback event. This method is required bu ICallbackEventHandler interface. It raises the onDrop OnDrop event, then, the onCallback OnCallback event This method is mainly used by framework and control developers.

Parameters

$param
TCallbackEventParameter
the parameter associated with the callback event

Implementation of

ICallbackEventHandler::raiseCallbackEvent()
public
# onDrop( object $dropParams )

Raises the onDrop event. The drop parameters are encapsulated into a TDropContainerEventParameter

Raises the onDrop event. The drop parameters are encapsulated into a TDropContainerEventParameter

Parameters

$dropParams
object
$dropControlId
public
# onCallback( TCallbackEventParameter $param )

This method is invoked when a callback is requested. The method raises 'OnCallback' event to fire up the event handlers. If you override this method, be sure to call the parent implementation so that the event handler can be invoked.

This method is invoked when a callback is requested. The method raises 'OnCallback' event to fire up the event handlers. If you override this method, be sure to call the parent implementation so that the event handler can be invoked.

Parameters

$param
TCallbackEventParameter
event parameter to be passed to the event handlers
protected array
# getPostBackOptions( )

Gets the post back options for this textbox.

Gets the post back options for this textbox.

Returns

array
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
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()
public
# createChildControls( )

Creates child control Override parent implementation to create a container which will contain all child controls. This container will be a TActivePanel, in order to allow user to update its content on callback.

Creates child control Override parent implementation to create a container which will contain all child controls. This container will be a TActivePanel, in order to allow user to update its content on callback.

Overrides

TControl::createChildControls()
public TControlCollection
# getControls( )

Override parent implementation to return the container control collection.

Override parent implementation to return the container control collection.

Returns

TControlCollection

Overrides

TControl::getControls()
public
# render( THtmlWriter $writer )

Renders and replaces the panel's content on the client-side. When render() is called before the OnPreRender event, such as when render() is called during a callback event handler, the rendering is defered until OnPreRender event is raised.

Renders and replaces the panel's content on the client-side. When render() is called before the OnPreRender event, such as when render() is called during a callback event handler, the rendering is defered until OnPreRender event is raised.

Parameters

$writer
THtmlWriter
html writer

Overrides

TPanel::render()
Methods inherited from TPanel
createStyle(), getBackImageUrl(), getDefaultButton(), getDirection(), getGroupingText(), getHorizontalAlign(), getScrollBars(), getTagName(), getWrap(), 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
__get(), addParsedObject(), addToPostDataLoader(), addedControl(), applyStyleSheetSkin(), autoBindProperty(), autoDataBindProperties(), bindProperty(), broadcastEvent(), bubbleEvent(), clearChildState(), clearControlState(), clearNamingContainer(), clearViewState(), convertUniqueIdToClientId(), createControlCollection(), dataBind(), dataBindChildren(), dataBindProperties(), ensureChildControls(), findControl(), findControlsByID(), findControlsByType(), focus(), getAdapter(), getAllowChildControls(), getAttribute(), getAttributes(), getChildControlsCreated(), getClientID(), getControlStage(), getControlState(), 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