ClaroFrame Class Reference

Inheritance diagram for ClaroFrame:

Public Member Functions
	__construct ($name, $src, $id= '')
	allowScrolling ($auto=false)
	disableResize ()
	noFrameBorder ()
	setFrameSpacing ($spacing)
	render ()
Private Attributes
	$src
	$name
	$id
	$scrolling = false
	$autoscroll = false
	$noresize = false
	$frameborder = true
	$framespacing = null

---

Detailed Description

Claroline html frame class

public

Definition at line 246 of file display.lib.php.

---

Constructor & Destructor Documentation

__construct	(	$	name,
		$	src,
		$	id = ''
	)

Constructor

public

Parameters:

	string	name, frame name
	string	src, frame content url
	string	id, frame id, optional, if not given the name will be used as the frame id

Definition at line 266 of file display.lib.php.

---

Member Function Documentation

allowScrolling

(

$

auto = false

)

Allow scrolling in frame

public

Parameters:

bool

auto, set to true to allow auto scrolling

Definition at line 279 of file display.lib.php.

disableResize

(

)

Disable frame resizing

public

Definition at line 290 of file display.lib.php.

noFrameBorder

(

)

Disable frame border

public

Definition at line 300 of file display.lib.php.

render

(

)

Render the frame to embed in a HTML frameset

public

See also:

ClaroFramesetElement::render()

Implements Display.

Definition at line 322 of file display.lib.php.

setFrameSpacing

(

$

spacing

)

Set space between frames

public

Parameters:

int

spacing, frame spacing

Definition at line 311 of file display.lib.php.

---

Field Documentation

$autoscroll = false [private]

Definition at line 252 of file display.lib.php.

$frameborder = true [private]

Definition at line 254 of file display.lib.php.

$framespacing = null [private]

Definition at line 255 of file display.lib.php.

$id [private]

Definition at line 250 of file display.lib.php.

$name [private]

Definition at line 249 of file display.lib.php.

$noresize = false [private]

Definition at line 253 of file display.lib.php.

$scrolling = false [private]

Definition at line 251 of file display.lib.php.

$src [private]

Definition at line 248 of file display.lib.php.

---

The documentation for this class was generated from the following file:

• claroline/claroline/inc/lib/display/display.lib.php