Class TInlineFrame

Description

Implements interfaces:

TInlineFrame class

TInlineFrame displays an inline frame (iframe) on a Web page. The location of the frame content is specified by FrameUrl. The frame's alignment is specified by Align. The MarginWidth and MarginHeight properties define the number of pixels to use as the left/right margins and top/bottom margins, respectively, within the inline frame. The ScrollBars property specifies whether scrollbars are provided for the inline frame. And DescriptionUrl gives the URI of a long description of the frame's contents.

Original Prado v2 IFrame Author Information

Located in /Web/UI/WebControls/TInlineFrame.php (line 34)

TComponent
   |
   --TApplicationComponent
      |
      --TControl
         |
         --TWebControl
            |
            --TInlineFrame
Method Summary
string getData ()
string getDescriptionUrl ()
string getFrameUrl ()
integer getMarginHeight ()
integer getMarginWidth ()
boolean getShowBorder ()
string getTagName ()
void setAlign (TInlineFrameAlign $value)
void setData (string $value)
void setDescriptionUrl (string $value)
void setFrameUrl (string $value)
void setMarginHeight (integer $value)
void setMarginWidth (integer $value)
void setShowBorder (boolean $value)
Methods
addAttributesToRender (line 195)

Adds attribute name-value pairs to renderer.

This overrides the parent implementation with additional button specific attributes.

  • access: protected
void addAttributesToRender (THtmlWriter $writer)
  • THtmlWriter $writer: the writer used for the rendering purpose

Redefinition of:
TWebControl::addAttributesToRender()
Adds attribute name-value pairs to renderer.
getAlign (line 47)
  • return: alignment of the iframe. Defaults to TInlineFrameAlign::NotSet.
  • access: public
TInlineFrameAlign getAlign ()
getData (line 116)

Returns the URL that this iframe will load content from This method is required by IDataRenderer.

It is the same as getFrameUrl().

string getData ()
getDescriptionUrl (line 63)
  • return: the URL to long description
  • access: public
string getDescriptionUrl ()
getFrameUrl (line 95)
  • return: URL that this iframe will load content from. Defaults to ''.
  • access: public
string getFrameUrl ()
getMarginHeight (line 174)
  • return: the amount of space, in pixels, that should be left between the frame's contents and the top and bottom margins. Defaults to -1, meaning not set.
  • access: public
integer getMarginHeight ()
getMarginWidth (line 154)
  • return: the amount of space, in pixels, that should be left between the frame's contents and the left and right margins. Defaults to -1, meaning not set.
  • access: public
integer getMarginWidth ()
getScrollBars (line 137)
  • return: the visibility and position of scroll bars in an iframe. Defaults to TInlineFrameScrollBars::Auto.
  • access: public
TInlineFrameScrollBars getScrollBars ()
getShowBorder (line 79)
  • return: whether there should be a visual separator between the frames. Defaults to true.
  • access: public
boolean getShowBorder ()
getTagName (line 39)
  • return: tag name of the iframe.
  • access: protected
string getTagName ()

Redefinition of:
TWebControl::getTagName()
Returns the tag name used for this control.
setAlign (line 55)
  • access: public
void setAlign (TInlineFrameAlign $value)
setData (line 129)

Sets the URL that this iframe will load content from.

This method is required by IDataRenderer. It is the same as setFrameUrl().

void setData (string $value)
  • string $value: the URL that this iframe will load content from
setDescriptionUrl (line 71)
  • access: public
void setDescriptionUrl (string $value)
  • string $value: the URL to the long description of the image.
setFrameUrl (line 103)
  • access: public
void setFrameUrl (string $value)
  • string $value: URL that this iframe will load content from.
setMarginHeight (line 183)
  • access: public
void setMarginHeight (integer $value)
  • integer $value: the amount of space, in pixels, that should be left between the frame's contents and the top and bottom margins.
setMarginWidth (line 163)
  • access: public
void setMarginWidth (integer $value)
  • integer $value: the amount of space, in pixels, that should be left between the frame's contents and the left and right margins.
setScrollBars (line 145)
  • access: public
void setScrollBars (TInlineFrameScrollBars $value)
setShowBorder (line 87)
  • access: public
void setShowBorder (boolean $value)
  • boolean $value: whether there should be a visual separator between the frames.

Inherited Methods

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 Mon, 21 Apr 2008 11:35:18 -0400 by phpDocumentor 1.3.0RC4