Class TDropContainer

Description

Implements interfaces:

TDropContainer is a panel where TDraggable controls can be dropped.

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

Properties :

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

Events:

  • version: $Id: TDropContainer.php 2517 2008-10-13 13:40:34Z tof $
  • license: http://www.pradosoft.com/license
  • copyright: Copyright © 2008, PradoSoft
  • author: Christophe BOULAIN (Christophe.Boulain@gmail.com)

Located in /Web/UI/ActiveControls/TDropContainer.php (line 40)

TComponent
   |
   --TApplicationComponent
      |
      --TControl
         |
         --TWebControl
            |
            --TPanel
               |
               --TDropContainer
Method Summary
TDropContainer __construct ()
void addAttributesToRender (mixed $writer)
string getAcceptCssClass ()
string getClientClassName ()
string getHoverCssClass ()
void onDrop (string $dropControlId)
void render (THtmlWriter $writer)
void setAcceptCssClass (string $value)
void setHoverCssClass (string $value)
Methods
Constructor __construct (line 49)

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.

  • access: public
TDropContainer __construct ()

Redefinition of:
TControl::__construct()
Constructor.
addAttributesToRender (line 177)

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

  • access: protected
void addAttributesToRender (mixed $writer)

Redefinition of:
TPanel::addAttributesToRender()
Adds attributes to renderer.
createChildControls (line 194)

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.

  • access: public
void createChildControls ()

Redefinition of:
TControl::createChildControls()
Creates child controls.
getAcceptCssClass (line 68)

Gets the Css class name that this container can accept.

  • access: public
string getAcceptCssClass ()
getActiveControl (line 58)
  • return: standard active control options.
  • access: public
TBaseActiveControl getActiveControl ()
getClientClassName (line 167)

Gets the name of the javascript class responsible for performing postback for this control.

This method overrides the parent implementation.

  • return: the javascript class name
  • access: protected
string getClientClassName ()
getControls (line 209)

Override parent implementation to return the container control collection.

  • access: public
TControlCollection getControls ()

Redefinition of:
TControl::getControls()
getHoverCssClass (line 97)

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

  • return: css class name during draggable hover.
  • access: public
string getHoverCssClass ()
getPostBackOptions (line 152)

Gets the post back options for this textbox.

  • access: protected
array getPostBackOptions ()
onCallback (line 143)

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.

  • access: public
void onCallback (TCallbackEventParameter $param)
onDrop (line 122)

Raises the onDrop event.

The dropped control is encapsulated into a TDropContainerEventParameter

  • access: public
void onDrop (string $dropControlId)
  • string $dropControlId
raiseCallbackEvent (line 110)

Raises callback event. This method is required bu ICallbackEventHandler interface.

It raises the OnDrop event, then, the OnCallback event This method is mainly used by framework and control developers.

  • access: public
void raiseCallbackEvent (TCallbackEventParameter $param)
render (line 222)

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.

  • access: public
void render (THtmlWriter $writer)

Redefinition of:
TWebControl::render()
Renders the control.
setAcceptCssClass (line 77)

Sets the Css class name that this container can accept.

  • access: public
void setAcceptCssClass (string $value)
  • string $value: comma delimited css class names.
setHoverCssClass (line 87)

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

  • access: public
void setHoverCssClass (string $value)
  • string $value: css class name during draggable hover.

Inherited Methods

Inherited From TPanel

TPanel::addAttributesToRender()
TPanel::createStyle()
TPanel::getBackImageUrl()
TPanel::getDefaultButton()
TPanel::getDirection()
TPanel::getGroupingText()
TPanel::getHorizontalAlign()
TPanel::getScrollBars()
TPanel::getTagName()
TPanel::getWrap()
TPanel::renderBeginTag()
TPanel::renderEndTag()
TPanel::setBackImageUrl()
TPanel::setDefaultButton()
TPanel::setDirection()
TPanel::setGroupingText()
TPanel::setHorizontalAlign()
TPanel::setScrollBars()
TPanel::setWrap()

Inherited From TWebControl

TWebControl::addAttributesToRender()
TWebControl::clearStyle()
TWebControl::copyBaseAttributes()
TWebControl::createStyle()
TWebControl::getAccessKey()
TWebControl::getBackColor()
TWebControl::getBorderColor()
TWebControl::getBorderStyle()
TWebControl::getBorderWidth()
TWebControl::getCssClass()
TWebControl::getDisplay()
TWebControl::getFont()
TWebControl::getForeColor()
TWebControl::getHasStyle()
TWebControl::getHeight()
TWebControl::getStyle()
TWebControl::getTabIndex()
TWebControl::getTagName()
TWebControl::getToolTip()
TWebControl::getWidth()
TWebControl::render()
TWebControl::renderBeginTag()
TWebControl::renderContents()
TWebControl::renderEndTag()
TWebControl::setAccessKey()
TWebControl::setBackColor()
TWebControl::setBorderColor()
TWebControl::setBorderStyle()
TWebControl::setBorderWidth()
TWebControl::setCssClass()
TWebControl::setDisplay()
TWebControl::setForeColor()
TWebControl::setHeight()
TWebControl::setStyle()
TWebControl::setTabIndex()
TWebControl::setToolTip()
TWebControl::setWidth()

Inherited From TControl

TControl::__construct()
TControl::addedControl()
TControl::addParsedObject()
TControl::addToPostDataLoader()
TControl::applyStyleSheetSkin()
TControl::autoBindProperty()
TControl::autoDataBindProperties()
TControl::bindProperty()
TControl::broadcastEvent()
TControl::bubbleEvent()
TControl::clearChildState()
TControl::clearControlState()
TControl::clearNamingContainer()
TControl::clearViewState()
TControl::convertUniqueIdToClientId()
TControl::createChildControls()
TControl::createControlCollection()
TControl::dataBind()
TControl::dataBindChildren()
TControl::dataBindProperties()
TControl::ensureChildControls()
TControl::findControl()
TControl::findControlsByID()
TControl::findControlsByType()
TControl::focus()
TControl::getAdapter()
TControl::getAllowChildControls()
TControl::getAttribute()
TControl::getAttributes()
TControl::getChildControlsCreated()
TControl::getClientID()
TControl::getControls()
TControl::getControlStage()
TControl::getControlState()
TControl::getCustomData()
TControl::getEnabled()
TControl::getEnableTheming()
TControl::getEnableViewState()
TControl::getHasAdapter()
TControl::getHasAttributes()
TControl::getHasChildInitialized()
TControl::getHasControls()
TControl::getHasInitialized()
TControl::getHasLoaded()
TControl::getHasLoadedPostData()
TControl::getHasPreRendered()
TControl::getID()
TControl::getNamingContainer()
TControl::getPage()
TControl::getParent()
TControl::getRegisteredObject()
TControl::getSkinID()
TControl::getSourceTemplateControl()
TControl::getTemplateControl()
TControl::getUniqueID()
TControl::getViewState()
TControl::getVisible()
TControl::hasAttribute()
TControl::initRecursive()
TControl::isDescendentOf()
TControl::isObjectRegistered()
TControl::loadRecursive()
TControl::loadState()
TControl::loadStateRecursive()
TControl::onDataBinding()
TControl::onInit()
TControl::onLoad()
TControl::onPreRender()
TControl::onUnload()
TControl::preRenderRecursive()
TControl::raiseBubbleEvent()
TControl::registerObject()
TControl::removeAttribute()
TControl::removedControl()
TControl::render()
TControl::renderChildren()
TControl::renderControl()
TControl::saveState()
TControl::saveStateRecursive()
TControl::setAdapter()
TControl::setAttribute()
TControl::setChildControlsCreated()
TControl::setControlStage()
TControl::setControlState()
TControl::setCustomData()
TControl::setEnabled()
TControl::setEnableTheming()
TControl::setEnableViewState()
TControl::setID()
TControl::setPage()
TControl::setSkinID()
TControl::setTemplateControl()
TControl::setViewState()
TControl::setVisible()
TControl::trackViewState()
TControl::traverseChildControls()
TControl::unbindProperty()
TControl::unloadRecursive()
TControl::unregisterObject()
TControl::__get()

Inherited From TApplicationComponent

TApplicationComponent::getApplication()
TApplicationComponent::getRequest()
TApplicationComponent::getResponse()
TApplicationComponent::getService()
TApplicationComponent::getSession()
TApplicationComponent::getUser()
TApplicationComponent::publishAsset()
TApplicationComponent::publishFilePath()

Inherited From TComponent

TComponent::addParsedObject()
TComponent::attachEventHandler()
TComponent::canGetProperty()
TComponent::canSetProperty()
TComponent::createdOnTemplate()
TComponent::detachEventHandler()
TComponent::evaluateExpression()
TComponent::evaluateStatements()
TComponent::getEventHandlers()
TComponent::getSubProperty()
TComponent::hasEvent()
TComponent::hasEventHandler()
TComponent::hasProperty()
TComponent::raiseEvent()
TComponent::setSubProperty()
TComponent::__get()
TComponent::__set()
Class Constants

Documentation generated on Sun, 11 Jan 2009 20:22:24 -0500 by phpDocumentor 1.3.0RC4