PHP Class Prado\Web\UI\WebControls\TInlineFrame

TInlineFrame displays an inline frame (iframe) on a Web page. The location of the frame content is specified by {@link setFrameUrl FrameUrl}. The frame's alignment is specified by {@link setAlign Align}. The {@link setMarginWidth MarginWidth} and {@link 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 {@link setScrollBars ScrollBars} property specifies whether scrollbars are provided for the inline frame. And {@link setDescriptionUrl DescriptionUrl} gives the URI of a long description of the frame's contents. Original Prado v2 IFrame Author Information

Since: 3.0

Author: Jason Ragsdale ([email protected])

Author: Harry Pottash ([email protected])

Inheritance: extends TWebControl, implements Prado\IDataRenderer

Datei anzeigen Open project: pradosoft/prado

Public Methods

Method	Description
getAlign ( ) : TInlineFrameAlign
getData ( ) : string	Returns the URL that this iframe will load content from This method is required by {@link \Prado\IDataRenderer}.
getDescriptionUrl ( ) : string
getFrameUrl ( ) : string
getHeight ( ) : integer
getMarginHeight ( ) : integer
getMarginWidth ( ) : integer
getScrollBars ( ) : TInlineFrameScrollBars
getShowBorder ( ) : boolean
getWidth ( ) : integer
setAlign ( $value )
setData ( $value )	Sets the URL that this iframe will load content from.
setDescriptionUrl ( $value )
setFrameUrl ( $value )
setHeight ( $value )
setMarginHeight ( $value )
setMarginWidth ( $value )
setScrollBars ( $value )
setShowBorder ( $value )
setWidth ( $value )

Protected Methods

Method	Description
addAttributesToRender ( $writer )	Adds attribute name-value pairs to renderer.
getTagName ( ) : string

Method Details

addAttributesToRender() protected method

This overrides the parent implementation with additional button specific attributes.

protected addAttributesToRender ( $writer )

getAlign() public method

public getAlign ( ) : TInlineFrameAlign
return	TInlineFrameAlign	alignment of the iframe. Defaults to TInlineFrameAlign::NotSet.

getData() public method

It is the same as {@link getFrameUrl()}.

getDescriptionUrl() public method

public getDescriptionUrl ( ) : string
return	string	the URL to long description

getFrameUrl() public method

public getFrameUrl ( ) : string
return	string	URL that this iframe will load content from. Defaults to ''.

getHeight() public method

public getHeight ( ) : integer
return	integer	the height of the control

getMarginHeight() public method

public getMarginHeight ( ) : integer
return	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.

getMarginWidth() public method

public getMarginWidth ( ) : integer
return	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.

getScrollBars() public method

public getScrollBars ( ) : TInlineFrameScrollBars
return	TInlineFrameScrollBars	the visibility and position of scroll bars in an iframe. Defaults to TInlineFrameScrollBars::Auto.

getShowBorder() public method

public getShowBorder ( ) : boolean
return	boolean	whether there should be a visual separator between the frames. Defaults to true.

getTagName() protected method

protected getTagName ( ) : string
return	string	tag name of the iframe.

getWidth() public method

public getWidth ( ) : integer
return	integer	the width of the control

setAlign() public method

public setAlign ( $value )

setData() public method

This method is required by {@link \Prado\IDataRenderer}. It is the same as {@link setFrameUrl()}.

setDescriptionUrl() public method

public setDescriptionUrl ( $value )

setFrameUrl() public method

public setFrameUrl ( $value )

setHeight() public method

public setHeight ( $value )

setMarginHeight() public method

public setMarginHeight ( $value )

setMarginWidth() public method

public setMarginWidth ( $value )

setScrollBars() public method

public setScrollBars ( $value )

setShowBorder() public method

public setShowBorder ( $value )

setWidth() public method

public setWidth ( $value )

public getData ( ) : string
return	string	the URL that this iframe will load content from