Package org.codice.ddf.ui.admin.api.module

Interface AdminModule

public interface AdminModule
Defines a module to be plugged into the admin ui

This code is experimental. While this interface is functional and tested, it may change or be removed in a future version of the library.

  • Method Summary

    Modifier and Type
    Method
    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.

  • Method Details

    • getName

      String getName()
      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.
      Returns:
      String

    • getId

      String getId()
      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.
      Returns:
      String

    • getJSLocation

      URI getJSLocation()
      Absolute path to the module JS file. This file can require in additional requirejs modules as needed.
      Returns:
      URI

    • getCSSLocation

      URI getCSSLocation()
      Absolute path to any CSS that accompanies this module. The CSS will be included globally.
      Returns:
      URI

    • getIframeLocation

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