An abstract object viewer class that all object viewer classes, whether built-in or custom-written, should extend. More...

Inheritance diagram for DMAbstractViewer:

Public Member Functions

__construct (DMObject $obj, DMMediaType $media_type, $width, $height)
viewerWillRender ()
Default implementation that does nothing.
setHelper (DMGenericTemplateHelper $helper)
setMediaType (DMMediaType $media_type)
setObject (DMObject $obj)
setWidth ($width)
setHeight ($height)

Protected Member Functions

Detailed Description

An abstract object viewer class that all object viewer classes, whether built-in or custom-written, should extend.

Author:: Alex Dolski <alex.dolski@unlv.edu> http://www.opensource.org/licenses/mit-license.php

Definition at line 16 of file DMAbstractViewer.php.

Constructor & Destructor Documentation

DMAbstractViewer::__construct	(	DMObject $	obj,
		DMMediaType $	media_type,
		$	width,
		$	height
	)

Parameters:

DMObject	obj
DMMediaType	media_type
int	width
int	height

Definition at line 36 of file DMAbstractViewer.php.

Member Function Documentation

DMAbstractViewer::getHeight ( ) [protected]

Returns:: string Height, including CSS units

Definition at line 113 of file DMAbstractViewer.php.

Referenced by DMQuickTimeViewer::getHTMLTag(), DMPaginatedPDFViewer::getHTMLTag(), DMNullViewer::getHTMLTag(), DMMonocleViewer::getHTMLTag(), DMMonocle2Viewer::getHTMLTag(), DMGenericPDFViewer::getHTMLTag(), DMGenericObjectViewer::getHTMLTag(), DMGenericImageViewer::getHTMLTag(), DMFileLinkViewer::getHTMLTag(), and DMMonocle2Viewer::viewerWillRender().

DMAbstractViewer::getHelper ( ) [protected]

Returns:: DMGenericTemplateHelper

Definition at line 56 of file DMAbstractViewer.php.

Referenced by SampleCustomViewer::viewerWillRender(), DMPaginatedPDFViewer::viewerWillRender(), DMMonocleViewer::viewerWillRender(), and DMMonocle2Viewer::viewerWillRender().

DMAbstractViewer::getMediaType ( ) [protected]

Returns:: string

Definition at line 70 of file DMAbstractViewer.php.

Referenced by DMQuickTimeViewer::getHTMLTag(), DMMonocleViewer::getHTMLTag(), DMMonocle2Viewer::getHTMLTag(), DMGenericPDFViewer::getHTMLTag(), DMGenericObjectViewer::getHTMLTag(), and DMFileLinkViewer::getHTMLTag().

DMAbstractViewer::getObject ( ) [protected]

Returns:: DMObject

Definition at line 84 of file DMAbstractViewer.php.

Referenced by SampleCustomViewer::getHTMLTag(), DMQuickTimeViewer::getHTMLTag(), DMPaginatedPDFViewer::getHTMLTag(), DMMonocleViewer::getHTMLTag(), DMMonocle2Viewer::getHTMLTag(), DMGenericPDFViewer::getHTMLTag(), DMGenericObjectViewer::getHTMLTag(), DMGenericImageViewer::getHTMLTag(), DMFileLinkViewer::getHTMLTag(), and DMMonocle2Viewer::viewerWillRender().

DMAbstractViewer::getWidth ( ) [protected]

Returns:: string Width, including CSS units

Definition at line 98 of file DMAbstractViewer.php.

Referenced by DMQuickTimeViewer::getHTMLTag(), DMPaginatedPDFViewer::getHTMLTag(), DMNullViewer::getHTMLTag(), DMMonocleViewer::getHTMLTag(), DMMonocle2Viewer::getHTMLTag(), DMGenericPDFViewer::getHTMLTag(), DMGenericObjectViewer::getHTMLTag(), DMGenericImageViewer::getHTMLTag(), DMFileLinkViewer::getHTMLTag(), and DMMonocle2Viewer::viewerWillRender().

DMAbstractViewer::setHeight ( $ height )

Parameters:

string height Height, including CSS units

Definition at line 121 of file DMAbstractViewer.php.

Referenced by __construct().

DMAbstractViewer::setHelper ( DMGenericTemplateHelper $ helper )

Parameters:

DMGenericTemplateHelper helper

Definition at line 63 of file DMAbstractViewer.php.

DMAbstractViewer::setMediaType ( DMMediaType $ media_type )

Parameters:

DMMediaType media_type

Definition at line 77 of file DMAbstractViewer.php.

Referenced by __construct().

DMAbstractViewer::setObject ( DMObject $ obj )

Parameters:

DMObject obj

Definition at line 91 of file DMAbstractViewer.php.

Referenced by __construct().

DMAbstractViewer::setWidth ( $ width )

Parameters:

string width Width, including CSS units

Definition at line 106 of file DMAbstractViewer.php.

Referenced by __construct().

DMAbstractViewer::viewerWillRender ( )

Default implementation that does nothing.

See DMObjectViewerDelegate for documentation of this method.

Returns:: void

Reimplemented in SampleCustomViewer, DMMonocle2Viewer, DMMonocleViewer, and DMPaginatedPDFViewer.

Definition at line 50 of file DMAbstractViewer.php.

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

DMAbstractViewer.php