SnapContentMediaInteractivateApplet Class Reference
[Content Modules]

Content module for Interactivate Applets. More...

Inheritance diagram for SnapContentMediaInteractivateApplet:

[legend]

List of all members.

Public Member Functions
	checkMedia ()
	Checks to make sure jarfile exists and is readable.
	getAppClass ()
	Gets applet class of applet.
	getHeight ()
	Gets height of applet.
	getJarName ()
	Gets original name of jarfile.
	getJarPath ()
	Gets path on server to jarfile.
	getJarURL ()
	Gets URL of jarfile.
	getSize ()
	INSERT BRIEF DESCRIPTION HERE.
	getWidth ()
	Gets width of applet.
	setAppClass ($oldCM, $appclass)
	Sets the applet class.
	setHeight ($oldCM, $height)
	Sets the applet height.
	setWidth ($oldCM, $width)
	Sets the applet width.
	updateFileList ()
	Updates entry in external file database for jarfile.
	uploadApplet ($tmpFile, $fileName, $appclass, $width, $height)
	Uploads applet jarfile into content module.

---

Detailed Description

Content module for Interactivate Applets.

Each content module stores information about an applet. There is one external file, which is the jarfile for the applet. The module also stores the width and height of the applet, as well as the name of the class that is the main class of the applet. No other information is stored because the jarfile contains parameters and the like. Additionally, this module handles generating the correct JavaScript and HTML to work with switcher.js, which is embedded in Snap2.

When generating HTML for an applet, you can use the following extra parameters:

• 'switcherPath' - URL of switcher.js to be used instead of default built-in to Snap2

---

Member Function Documentation

SnapContentMediaInteractivateApplet::checkMedia

(

)

Checks to make sure jarfile exists and is readable.

Returns:

[boolean]: whether jarfile exists and is readable

Reimplemented from SnapContent.

SnapContentMediaInteractivateApplet::getAppClass

(

)

Gets applet class of applet.

Returns:

[integer]: applet class of applet, or false if invalid content module

SnapContentMediaInteractivateApplet::getHeight

(

)

Gets height of applet.

Returns:

[integer]: height of applet, or false if invalid content module

SnapContentMediaInteractivateApplet::getJarName

(

)

Gets original name of jarfile.

You should never need to call this method since the name of the jarfile may not be correct or worthwhile (it is whatever the user had it called on their machine).

Returns:

[string]: original name of jarfile

SnapContentMediaInteractivateApplet::getJarPath

(

)

Gets path on server to jarfile.

You should never need to call this method.

Returns:

[string]: path to jarfile on server

SnapContentMediaInteractivateApplet::getJarURL

(

)

Gets URL of jarfile.

Returns:

[string]: URL to jarfile of applet, or false if invalid content module

SnapContentMediaInteractivateApplet::getSize

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

SnapContentMediaInteractivateApplet::getWidth

(

)

Gets width of applet.

Returns:

[integer]: width of applet, or false if invalid content module

SnapContentMediaInteractivateApplet::setAppClass	(	$	oldCM,
		$	appclass
	)

Sets the applet class.

This method should only be called on a content module that's being used for a version that is being copied from an existing version.

Parameters:

	$oldCM	[SnapContentMediaInteractivateApplet]: content module to copy additional data from
	$appclass	[string]: name of applet main class (e.g., Histogram.class)

Returns:

[boolean]: success or failure

SnapContentMediaInteractivateApplet::setHeight	(	$	oldCM,
		$	height
	)

Sets the applet height.

This method should only be called on a content module that's being used for a version that is being copied from an existing version.

Parameters:

	$oldCM	[SnapContentMediaInteractivateApplet]: content module to copy additional data from
	$height	[integer]: height of applet

Returns:

[boolean]: success or failure

SnapContentMediaInteractivateApplet::setWidth	(	$	oldCM,
		$	width
	)

Sets the applet width.

This method should only be called on a content module that's being used for a version that is being copied from an existing version.

Parameters:

	$oldCM	[SnapContentMediaInteractivateApplet]: content module to copy additional data from
	$width	[integer]: width of applet

Returns:

[boolean]: success or failure

SnapContentMediaInteractivateApplet::updateFileList

(

)

Updates entry in external file database for jarfile.

Returns:

[boolean]: success or failure

Reimplemented from SnapContent.

SnapContentMediaInteractivateApplet::uploadApplet	(	$	tmpFile,
		$	fileName,
		$	appclass,
		$	width,
		$	height
	)

Uploads applet jarfile into content module.

This method is straightforward and simply fills the content module with a jarfile and a few bits of information needed to embed the applet, such as the width and height. There are no optional parameters, or additional configuration options.

Parameters:

	$tmpFile	[string]: path to jarfile on server
	$fileName	[string]: original name of jarfile (e.g., histogram.jar)
	$appclass	[string]: name of class file that is the main class for the applet (e.g., 'Histogram.class')
	$width	[integer]: width of applet in pixels
	$height	[integer]: height of applet in pixels

Returns:

[boolean]: success or failure

---

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

• snap2/content/SnapContentMediaInteractivateApplet.php5