org.openmrs.module.web.extension

Class BoxExt

java.lang.Object

org.openmrs.module.Extension

org.openmrs.module.web.extension.BoxExt

public abstract class BoxExt
extends Extension

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
BoxExt()

Method Summary

Modifier and Type	Method and Description
abstract String	getContent() Returns the content used for the box.
Extension.MEDIA_TYPE	getMediaType() Sets the content type of this extension.
abstract String	getPortletUrl()
String	getRequiredPrivilege() Returns the required privilege in order to see this section.
abstract String	getTitle() The title is used as the title for the boxHeader.

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

BoxExt

public BoxExt()

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

getPortletUrl

public abstract String getPortletUrl()

Returns:

The message code of the label of this link

getTitle

public abstract String getTitle()

The title is used as the title for the boxHeader. The returned String can be either straight up plain text or a Spring message code.

Returns:

String title

getContent

public abstract String getContent()

Returns the content used for the box.

Returns:

Content string

getRequiredPrivilege

public String getRequiredPrivilege()

Returns the required privilege in order to see this section. Can be a comma delimited list of privileges. If the default empty string is returned, only an authenticated user is required

Returns:

Privilege string