Ibuildings - Docs For Class atkFrameSet

Inherited Properties	Inherited Methods
Inherited From atkAbstractFrame atkAbstractFrame::$m_childs atkAbstractFrame::$m_dimension	Inherited From atkAbstractFrame atkAbstractFrame::atkAbstractFrame() Default constructor atkAbstractFrame::addChild() Add a child to the frameset. atkAbstractFrame::getDimension() Return the dimension of the frame/frameset, within its parent frameset. atkAbstractFrame::render() Abstract render method. Derived classes should implement this method.

Inherited Properties

Inherited Methods

Inherited From atkAbstractFrame

atkAbstractFrame::$m_childs

atkAbstractFrame::$m_dimension

Inherited From atkAbstractFrame

atkAbstractFrame::atkAbstractFrame()

Default constructor

atkAbstractFrame::addChild()

Add a child to the frameset.

atkAbstractFrame::getDimension()

Return the dimension of the frame/frameset, within its parent frameset.

atkAbstractFrame::render()

Abstract render method. Derived classes should implement this method.

[ Top ]

Property Summary

mixed	$m_border
string	$m_id	Frameset ID
mixed	$m_noframes
mixed	$m_orientation

[ Top ]

Method Summary

atkFrameSet	atkFrameSet()	Default constructor.
String	getDimensions()	Returns a dimension specifier ("70,10,*") based on the dimensions of the framesets' childs.
String	render()	Render the frameset to html
atkFrameSet	setId()	Set the id of the frameset

[ Top ]

Properties

mixed $m_border [line 38]

[ Top ]

string $m_id [line 46]

Frameset ID

[ Top ]

mixed $m_noframes [line 40]

[ Top ]

mixed $m_orientation [line 39]

[ Top ]

Methods

Constructor atkFrameSet [line 66]

atkFrameSet atkFrameSet(
[int
$dimension = "*"], [int
$orientation = FRAMESET_VERTICAL], [int
$border = 0], [String
$noframes = ''] 
)

Default constructor.

Parameters:

int	$dimension:	The height or width of this frameset within its parent frameset. Whether you are specifying height or width depends on the orientation of the parent frameset.
int	$orientation:	The orientation of child frames within this frameset. Possible values: FRAMESET_VERTICAL, FRAMESET_HORIZONTAL.
int	$border:	The width in pixels of the border of the frameset.
String	$noframes:	The text to display instead of the frameset if frames are not supported by the browser. This param needs to be specified only for the outmost frameset. It is ignored by inner framesets.

[ Top ]

getDimensions [line 115]

String getDimensions(
)

Returns a dimension specifier ("70,10,*") based on the dimensions of the framesets' childs.

[ Top ]

render [line 95]

String render(
[boolean
$embedded = false] 
)

Render the frameset to html

Parameters:

boolean

$embedded:

If set to true, the frameset is treated as the outmost frameset, causing it to render the noframes tag for frameless browsers.

API Tags:

Return:

HTML fragment containing a frameset.

Redefinition of:

atkAbstractFrame::render(): Abstract render method. Derived classes should implement this method.

[ Top ]

setId [line 81]

atkFrameSet setId(
string
$id 
)

Set the id of the frameset

Parameters:

string

$id:

[ Top ]