dmBridge PHP API
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


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.


Member Function Documentation

DMObjectViewerDelegate::getHTMLTag ( )
DMObjectViewerDelegate::getHTMLTagNoJS ( )
DMObjectViewerDelegate::isLowBandwidthCompatible ( )

Whether the viewer is "bandwidth-safe," e.g.

whether the content it loads can be safely viewed over a subjectively "slow" connection.

Returns:
boolean
Since:
2.1

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

DMObjectViewerDelegate::setHeight ( height)
Parameters:
stringheight HTML height, as a CSS-compatible string
DMObjectViewerDelegate::setMediaType ( DMMediaType media_type)
Parameters:
DMMediaTypemedia_type Valid media (MIME) type
DMObjectViewerDelegate::setObject ( DMObject obj)
Parameters:
DMObjectobj The object to "view"
DMObjectViewerDelegate::setWidth ( width)
Parameters:
stringwidth HTML width, as a CSS-compatible 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:
 All Data Structures Functions Variables