DMObjectViewerDelegate Interface Reference

An object viewer interface that all object viewer classes, whether built-in or custom, are required to implement. More...

Inheritance diagram for DMObjectViewerDelegate:

Public Member Functions

• __construct (DMObject $obj, DMMediaType $media_type, $width, $height)
• viewerWillRender ()

  Delegate method, called before the viewer is rendered.
  

• getHTMLTag ()
• getHTMLTagNoJS ()
• setMediaType (DMMediaType $media_type)
• getName ()
• setObject (DMObject $obj)
• setWidth ($width)
• setHeight ($height)

---

Detailed Description

An object viewer interface that all object viewer classes, whether built-in or custom, are required to implement.

See also:

DMGenericObjectViewer

Author:

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

Definition at line 17 of file DMObjectViewerDelegate.php.

---

Constructor & Destructor Documentation

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

Parameters:

DMObject	obj The object to "view"
DMMediaType	media_type Valid Internet media type
string	width CSS-compatible width string
int	height

---

Member Function Documentation

DMObjectViewerDelegate::getHTMLTag

(

)

Returns:

string HTML tag that renders the viewer

Implemented in SampleCustomViewer, DMFileLinkViewer, DMGenericImageViewer, DMGenericObjectViewer, DMGenericPDFViewer, DMMonocle2Viewer, DMMonocleViewer, DMNullViewer, DMPaginatedPDFViewer, and DMQuickTimeViewer.

DMObjectViewerDelegate::getHTMLTagNoJS

(

)

Returns:

string HTML tag that renders the viewer

Implemented in SampleCustomViewer, DMFileLinkViewer, DMGenericImageViewer, DMGenericObjectViewer, DMGenericPDFViewer, DMMonocle2Viewer, DMMonocleViewer, DMNullViewer, DMPaginatedPDFViewer, and DMQuickTimeViewer.

DMObjectViewerDelegate::getName

(

)

Returns:

The name of the viewer

Implemented in SampleCustomViewer, DMFileLinkViewer, DMGenericImageViewer, DMGenericObjectViewer, DMGenericPDFViewer, DMMonocle2Viewer, DMMonocleViewer, DMNullViewer, DMPaginatedPDFViewer, and DMQuickTimeViewer.

DMObjectViewerDelegate::setHeight

(

$

height

)

Parameters:

int	height HTML height

DMObjectViewerDelegate::setMediaType

(

DMMediaType $

media_type

)

Parameters:

DMMediaType

media_type Valid media (MIME) type

DMObjectViewerDelegate::setObject

(

DMObject $

obj

)

Parameters:

DMObject

obj The object to "view"

DMObjectViewerDelegate::setWidth

(

$

width

)

Parameters:

string

width HTML width, as a CSS-compatible width string

DMObjectViewerDelegate::viewerWillRender

(

)

Delegate method, called before the viewer is rendered.

Necessary scripts, stylesheets, etc. should be added here.

Implemented in SampleCustomViewer, DMMonocle2Viewer, DMMonocleViewer, and DMPaginatedPDFViewer.

---

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

• DMObjectViewerDelegate.php