org.codice.ui.admin.docs

Class DocsModule

java.lang.Object

org.codice.ui.admin.docs.DocsModule

All Implemented Interfaces:

AdminModule

public class DocsModule
extends Object
implements AdminModule

Constructor Summary

Constructors

Constructor and Description
DocsModule()

Method Summary

Modifier and Type	Method and Description
URI	getCSSLocation() Absolute path to any CSS that accompanies this module.
String	getId() Returns the id that will be injected into the DOM.
URI	getIframeLocation() Absolute path to an IFrame to embed.
URI	getJSLocation() Absolute path to the module JS file.
String	getName() Returns the name of the module.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocsModule

public DocsModule()

Method Detail

getName

public String getName()

Description copied from interface: AdminModule

Returns the name of the module. This refers to the module name that will be attached to the Marionette object as well as the text of the module's tab. This must not contain spaces.

Specified by:

getName in interface AdminModule

Returns:

String

getId

public String getId()

Description copied from interface: AdminModule

Returns the id that will be injected into the DOM. If using Marionette, one can call App. within the module to return the region where the module should be rendered.

Specified by:

getId in interface AdminModule

Returns:

String

getJSLocation

public URI getJSLocation()

Description copied from interface: AdminModule

Absolute path to the module JS file. This file can require in additional requirejs modules as needed.

Specified by:

getJSLocation in interface AdminModule

Returns:

URI

getCSSLocation

public URI getCSSLocation()

Description copied from interface: AdminModule

Absolute path to any CSS that accompanies this module. The CSS will be included globally.

Specified by:

getCSSLocation in interface AdminModule

Returns:

URI

getIframeLocation

public URI getIframeLocation()

Description copied from interface: AdminModule

Absolute path to an IFrame to embed. JSLocation and CSSLocation will be ignored if this call returns a valid URI.

Specified by:

getIframeLocation in interface AdminModule

Returns:

URI