org.openmrs.module.web.extension

Class HeaderIncludeExt

java.lang.Object

org.openmrs.module.Extension

org.openmrs.module.web.extension.HeaderIncludeExt

public abstract class HeaderIncludeExt
extends Extension

The header include extension allows a module developer to include extra files (css, javascript) within the header of every page. This could be used to include a new javascript library, CSS styles, etc. In order to include headers, a module developer should implement the getHeaderFiles() method and return a collection of file names ("myjavascript.js", "mycss.css") that reside in the modules resources directory (i.e. "web/module/resources").

Nested Class Summary

Nested classes/interfaces inherited from class org.openmrs.module.Extension

Extension.MEDIA_TYPE

Field Summary

Fields inherited from class org.openmrs.module.Extension

extensionIdSeparator

Constructor Summary

Constructors

Constructor and Description
HeaderIncludeExt()

Method Summary

Modifier and Type	Method and Description
abstract List<String>	getHeaderFiles() Returns references to header files in the module resource directory.
Extension.MEDIA_TYPE	getMediaType() Sets the content type of this extension.

Methods inherited from class org.openmrs.module.Extension

getExtensionId, getModuleId, getOverrideContent, getParameterMap, getPointId, initialize, setModuleId, setParameterMap, setPointId, toExtensionId, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HeaderIncludeExt

public HeaderIncludeExt()

Method Detail

getMediaType

public Extension.MEDIA_TYPE getMediaType()

Description copied from class: Extension

Sets the content type of this extension. If null is returned this extension should work across all medium types

Specified by:

getMediaType in class Extension

Returns:

type of the medium that this extension works for

See Also:

Extension.getMediaType()

getHeaderFiles

public abstract List<String> getHeaderFiles()

Returns references to header files in the module resource directory.

Returns:

a collection of header files