Base class of all themes.

The theme class controls which files will be created through the getUrls function. It returns an array of UrlMapping instances defining the target files, models and templates to use. Additionally themes can subscribe to the events emitted by Renderer to control and manipulate the output process.

Hierarchy

Constructors

  • Create a new BaseTheme instance.

    Parameters

    • renderer: Renderer

      The renderer this theme is attached to.

    Returns Theme

Properties

componentName: string

The name of this component as set by the

Component

decorator.

Accessors

  • Return the application / root component instance.

    Returns Application

  • get owner(): O
  • Return the owner of this component.

    Returns O

Methods

  • Parameters

    Returns Theme

  • Map the models of the given project to the desired output files. It is assumed that with the project structure:

    A
    |- B
       |- C
    

    If B has a UrlMapping, then A also has a UrlMapping, and C may or may not have a UrlMapping. If B does not have a UrlMapping, then A may or may not have a UrlMapping, but C must not have a UrlMapping.

    Returns

    A list of UrlMapping instances defining which models should be rendered to which files.

    Parameters

    Returns UrlMapping<any>[]

  • initialize(): void
  • Initialize this component.

    Returns void

  • Inversion-of-control versions of on. Tell this object to listen to an event in another object... keeping track of what it's listening to for easier unbinding later.

    Parameters

    Returns Theme

  • Inversion-of-control versions of once.

    Parameters

    Returns Theme

  • Parameters

    Returns Theme

  • Remove one or many callbacks. If context is null, removes all callbacks with that function. If callback is null, removes all callbacks for the event. If name is null, removes all bound callbacks for all events.

    Returns Theme

  • Parameters

    • eventMap: undefined | EventMap
    • Optional context: any

    Returns Theme

  • Parameters

    • name: undefined | string
    • Optional callback: EventCallback
    • Optional context: any

    Returns Theme

  • Bind an event to a callback function. Passing "all" will bind the callback to all events fired.

    Parameters

    • eventMap: EventMap
    • Optional context: any

    Returns Theme

  • Parameters

    Returns Theme

  • Parameters

    • name: string
    • callback: EventCallback
    • Optional context: any
    • Optional priority: number

    Returns Theme

  • Bind an event to only be triggered a single time. After the first time the callback is invoked, its listener will be removed. If multiple events are passed in using the space-separated syntax, the handler will fire once for each event, not once for a combination of all events.

    Parameters

    • eventMap: EventMap
    • Optional context: any

    Returns Theme

  • Parameters

    • name: string
    • callback: EventCallback
    • Optional context: any
    • Optional priority: any

    Returns Theme

  • Renders the provided page to a string, which will be written to disk by the Renderer

    Parameters

    Returns string

  • Tell this object to stop listening to either specific events ... or to every object it's currently listening to.

    Parameters

    Returns Theme

  • Trigger one or many events, firing all bound callbacks. Callbacks are passed the same arguments as trigger is, apart from the event name (unless you're listening on "all", which will cause your callback to receive the true name of the event as the first argument).

    Parameters

    Returns Theme

Generated using TypeDoc