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 TInlineFrame

TInlineFrame class

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

Original Prado v2 IFrame Author Information

TComponent
Extended by TApplicationComponent
Extended by TControl implements IRenderable, IBindable
Extended by TWebControl implements IStyleable
Extended by TInlineFrame implements IDataRenderer
Package: System\Web\UI\WebControls
Copyright: Copyright © 2005-2014 PradoSoft
License: http://www.pradosoft.com/license/
Author: Jason Ragsdale <jrags@jasrags.net>
Author: Harry Pottash <hpottash@gmail.com>
Since: 3.0
Located at Web/UI/WebControls/TInlineFrame.php
Methods summary
protected string
# getTagName( )

Returns

string
tag name of the iframe.

Overrides

TWebControl::getTagName()
public TInlineFrameAlign
# getAlign( )

Returns

TInlineFrameAlign
alignment of the iframe. Defaults to TInlineFrameAlign::NotSet.
public
# setAlign( TInlineFrameAlign $value )

Parameters

$value
TInlineFrameAlign
alignment of the iframe.
public string
# getDescriptionUrl( )

Returns

string
the URL to long description
public
# setDescriptionUrl( string $value )

Parameters

$value
string
the URL to the long description of the image.
public boolean
# getShowBorder( )

Returns

boolean
whether there should be a visual separator between the frames. Defaults to true.
public
# setShowBorder( boolean $value )

Parameters

$value
boolean
whether there should be a visual separator between the frames.
public string
# getFrameUrl( )

Returns

string
URL that this iframe will load content from. Defaults to ''.
public
# setFrameUrl( string $value )

Parameters

$value
string
URL that this iframe will load content from.
public string
# getData( )

Returns the URL that this iframe will load content from This method is required by IDataRenderer. It is the same as TInlineFrame::getFrameUrl().

Returns the URL that this iframe will load content from This method is required by IDataRenderer. It is the same as TInlineFrame::getFrameUrl().

Returns

string
the URL that this iframe will load content from

Since

3.1.0

See

TInlineFrame::getFrameUrl()

Implementation of

IDataRenderer::getData()
public
# setData( string $value )

Sets the URL that this iframe will load content from. This method is required by IDataRenderer. It is the same as TInlineFrame::setFrameUrl().

Sets the URL that this iframe will load content from. This method is required by IDataRenderer. It is the same as TInlineFrame::setFrameUrl().

Parameters

$value
string
the URL that this iframe will load content from

Since

3.1.0

See

TInlineFrame::setFrameUrl()

Implementation of

IDataRenderer::setData()
public TInlineFrameScrollBars
# getScrollBars( )

Returns

TInlineFrameScrollBars
the visibility and position of scroll bars in an iframe. Defaults to TInlineFrameScrollBars::Auto.
public
# setScrollBars( TInlineFrameScrollBars $value )

Parameters

$value
TInlineFrameScrollBars
the visibility and position of scroll bars in an iframe.
public integer
# getMarginWidth( )

Returns

integer
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.
public
# setMarginWidth( integer $value )

Parameters

$value
integer
the amount of space, in pixels, that should be left between the frame's contents and the left and right margins.
public integer
# getMarginHeight( )

Returns

integer
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.
public
# setMarginHeight( integer $value )

Parameters

$value
integer
the amount of space, in pixels, that should be left between the frame's contents and the top and bottom margins.
protected
# addAttributesToRender( THtmlWriter $writer )

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

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

Parameters

$writer
THtmlWriter
the writer used for the rendering purpose

Overrides

TWebControl::addAttributesToRender()
Methods inherited from TWebControl
clearStyle(), copyBaseAttributes(), createStyle(), getAccessKey(), getBackColor(), getBorderColor(), getBorderStyle(), getBorderWidth(), getCssClass(), getDecorator(), getDisplay(), getEnsureId(), getFont(), getForeColor(), getHasStyle(), getHeight(), getStyle(), getTabIndex(), getToolTip(), getWidth(), onPreRender(), 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