A C D E G I M O R S

A

ADD_URL - Static variable in class org.xwiki.rendering.internal.macro.dashboard.DashboardMacro

The identifier of the add url metadata.

C

CLASS - Static variable in class org.xwiki.rendering.internal.macro.dashboard.ColumnsDashboardRenderer

The HTML class attribute name.

CLASS - Static variable in class org.xwiki.rendering.internal.macro.dashboard.DefaultGadgetRenderer

The HTML class attribute name.

ColumnsDashboardRenderer - Class in org.xwiki.rendering.internal.macro.dashboard

The columns dashboard renderer, that renders the list of passed gadgets in columns, and interprets the positions as pairs of column number and gadget index.

ColumnsDashboardRenderer() - Constructor for class org.xwiki.rendering.internal.macro.dashboard.ColumnsDashboardRenderer

currentReferenceEntityResolver - Variable in class org.xwiki.rendering.internal.macro.dashboard.DefaultGadgetSource

The current entity reference resolver, to resolve the gadgets class reference.

currentReferenceResolver - Variable in class org.xwiki.rendering.internal.macro.dashboard.DefaultGadgetSource

The current string reference resolver, to resolve the current document reference in the metadata of the block of the current macro.

D

DashboardMacro - Class in org.xwiki.rendering.internal.macro.dashboard

The dashboard macro, to display other macros as gadgets in a dashboard, using a container to include its contents.

DashboardMacro() - Constructor for class org.xwiki.rendering.internal.macro.dashboard.DashboardMacro

Instantiates the dashboard macro, setting the name, description and parameters type.

DashboardMacroParameters - Class in org.xwiki.rendering.macro.dashboard

Parameters for the dashboard macro.

DashboardMacroParameters() - Constructor for class org.xwiki.rendering.macro.dashboard.DashboardMacroParameters

DashboardRenderer - Interface in org.xwiki.rendering.macro.dashboard

Renders the passed list of gadgets as a piece of XDOM, to be added in a tree after, handling the layout of the gadgets.

decorateGadget(Gadget) - Method in class org.xwiki.rendering.internal.macro.dashboard.DefaultGadgetRenderer

Decorates the passed gadget and renders it as a list of XDOM blocks.

decorateGadget(Gadget) - Method in class org.xwiki.rendering.internal.macro.dashboard.EditableGadgetRenderer

Decorates the passed gadget and renders it as a list of XDOM blocks.

decorateGadget(Gadget) - Method in interface org.xwiki.rendering.macro.dashboard.GadgetRenderer

Decorates the passed gadget and renders it as a list of XDOM blocks.

DefaultGadgetRenderer - Class in org.xwiki.rendering.internal.macro.dashboard

Default implementation of the gadget renderer, rendering the title of the gadget in a level 2 heading and the content as is, in a container that helps group it together and separate from title.

DefaultGadgetRenderer() - Constructor for class org.xwiki.rendering.internal.macro.dashboard.DefaultGadgetRenderer

DefaultGadgetSource - Class in org.xwiki.rendering.internal.macro.dashboard

Default gadget reader, reads the gadgets from XWiki Objects attached to the current document.

DefaultGadgetSource() - Constructor for class org.xwiki.rendering.internal.macro.dashboard.DefaultGadgetSource

E

EDIT_URL - Static variable in class org.xwiki.rendering.internal.macro.dashboard.DashboardMacro

The identifier of the edit url metadata.

EditableGadgetRenderer - Class in org.xwiki.rendering.internal.macro.dashboard

Editable gadget renderer, that renders the gadget as in view mode, but with additional metadata that allows editing the gadget parameters.

EditableGadgetRenderer() - Constructor for class org.xwiki.rendering.internal.macro.dashboard.EditableGadgetRenderer

execute(DashboardMacroParameters, String, MacroTransformationContext) - Method in class org.xwiki.rendering.internal.macro.dashboard.DashboardMacro

execution - Variable in class org.xwiki.rendering.internal.macro.dashboard.DefaultGadgetSource

The execution context, to grab XWiki context and access to documents.

G

Gadget - Class in org.xwiki.rendering.macro.dashboard

Abstraction for a gadget to put on a dashboard, to contain its title, content and position.

Gadget(String, List<Block>, List<Block>, String) - Constructor for class org.xwiki.rendering.macro.dashboard.Gadget

Creates a gadget from a title, content and position.

GADGET_CONTAINER - Static variable in class org.xwiki.rendering.internal.macro.dashboard.DashboardMacro

The marker to set as class parameter for the gadget containers in this dashboard, i.e.

GADGET_CONTAINER_PREFIX - Static variable in class org.xwiki.rendering.internal.macro.dashboard.DashboardMacro

The prefix of the id of the gadget containers in this dashboard, i.e.

gadgetContentRenderer - Variable in class org.xwiki.rendering.internal.macro.dashboard.EditableGadgetRenderer

The macro content renderer, to render the macro as annotated XHTML to be editable.

GadgetRenderer - Interface in org.xwiki.rendering.macro.dashboard

Decorates the passed gadget and renders it as a full piece of XDOM, a single list of blocks that can be added in the tree after.

GadgetSource - Interface in org.xwiki.rendering.macro.dashboard

Reads the gadgets for the dashboard macro which is being executed.

getContent() - Method in class org.xwiki.rendering.macro.dashboard.Gadget

getDashboardRenderer(String) - Method in class org.xwiki.rendering.internal.macro.dashboard.DashboardMacro

getDashboardSourceMetadata(String, MacroTransformationContext) - Method in class org.xwiki.rendering.internal.macro.dashboard.DefaultGadgetSource

Get the metadata about this dashboard source, such as source document fullname, gadget add url, gadget remove url, etc, to pass to the client.

getDashboardSourceMetadata(String, MacroTransformationContext) - Method in interface org.xwiki.rendering.macro.dashboard.GadgetSource

Get the metadata about this dashboard source, such as source document fullname, gadget add url, gadget remove url, etc, to pass to the client.

getGadgetEditMetadata(Gadget) - Method in class org.xwiki.rendering.internal.macro.dashboard.EditableGadgetRenderer

getGadgetRenderer(boolean) - Method in class org.xwiki.rendering.internal.macro.dashboard.DashboardMacro

getGadgets(String, MacroTransformationContext) - Method in class org.xwiki.rendering.internal.macro.dashboard.DefaultGadgetSource

Reads the gadgets for the passed macro transformation context.

getGadgets(String, MacroTransformationContext) - Method in interface org.xwiki.rendering.macro.dashboard.GadgetSource

Reads the gadgets for the passed macro transformation context.

getId() - Method in class org.xwiki.rendering.macro.dashboard.Gadget

getLayout() - Method in class org.xwiki.rendering.macro.dashboard.DashboardMacroParameters

getPosition() - Method in class org.xwiki.rendering.macro.dashboard.Gadget

getSource() - Method in class org.xwiki.rendering.macro.dashboard.DashboardMacroParameters

getStyle() - Method in class org.xwiki.rendering.macro.dashboard.DashboardMacroParameters

getTitle() - Method in class org.xwiki.rendering.macro.dashboard.Gadget

getTitleSource() - Method in class org.xwiki.rendering.macro.dashboard.Gadget

I

ID - Static variable in class org.xwiki.rendering.internal.macro.dashboard.ColumnsDashboardRenderer

The HTML id attribute name.

ID - Static variable in class org.xwiki.rendering.internal.macro.dashboard.DefaultGadgetRenderer

The HTML id attribute name.

includeResources(boolean) - Method in class org.xwiki.rendering.internal.macro.dashboard.DashboardMacro

Includes the js and css resources for the dashboard macro.

isEditing() - Method in class org.xwiki.rendering.internal.macro.dashboard.DefaultGadgetSource

isEditing() - Method in interface org.xwiki.rendering.macro.dashboard.GadgetSource

M

MACRO_NAME - Static variable in class org.xwiki.rendering.internal.macro.dashboard.DashboardMacro

The name of this macro.

METADATA - Static variable in class org.xwiki.rendering.internal.macro.dashboard.DashboardMacro

The identifier of the metadata block for this dashboard (class parameter of the generated XDOM container that holds the rest of the metadata).

METADATA - Static variable in class org.xwiki.rendering.internal.macro.dashboard.EditableGadgetRenderer

The identifier of the metadata block for this dashboard (class parameter of the generated XDOM container that holds the rest of the metadata).

O

org.xwiki.rendering.internal.macro.dashboard - package org.xwiki.rendering.internal.macro.dashboard

org.xwiki.rendering.macro.dashboard - package org.xwiki.rendering.macro.dashboard

R

REMOVE_URL - Static variable in class org.xwiki.rendering.internal.macro.dashboard.DashboardMacro

The identifier of the remove url metadata.

renderGadgets(List<Gadget>, GadgetRenderer, MacroTransformationContext) - Method in class org.xwiki.rendering.internal.macro.dashboard.ColumnsDashboardRenderer

Renders the passed gadgets in a list of blocks, to be added in an XDOM and rendered after.

renderGadgets(List<Gadget>, GadgetRenderer, MacroTransformationContext) - Method in interface org.xwiki.rendering.macro.dashboard.DashboardRenderer

Renders the passed gadgets in a list of blocks, to be added in an XDOM and rendered after.

S

setContent(List<Block>) - Method in class org.xwiki.rendering.macro.dashboard.Gadget

setId(String) - Method in class org.xwiki.rendering.macro.dashboard.Gadget

setLayout(String) - Method in class org.xwiki.rendering.macro.dashboard.DashboardMacroParameters

setPosition(String) - Method in class org.xwiki.rendering.macro.dashboard.Gadget

setSource(String) - Method in class org.xwiki.rendering.macro.dashboard.DashboardMacroParameters

setStyle(String) - Method in class org.xwiki.rendering.macro.dashboard.DashboardMacroParameters

setTitle(List<Block>) - Method in class org.xwiki.rendering.macro.dashboard.Gadget

setTitleSource(String) - Method in class org.xwiki.rendering.macro.dashboard.Gadget

SOURCE_PAGE - Static variable in class org.xwiki.rendering.internal.macro.dashboard.DashboardMacro

The identifier of the source page metadata.

SOURCE_SPACE - Static variable in class org.xwiki.rendering.internal.macro.dashboard.DashboardMacro

The identifier of the source space metadata.

SOURCE_URL - Static variable in class org.xwiki.rendering.internal.macro.dashboard.DashboardMacro

The identifier of the source url metadata.

SOURCE_WIKI - Static variable in class org.xwiki.rendering.internal.macro.dashboard.DashboardMacro

The identifier of the source wiki metadata.

supportsInlineMode() - Method in class org.xwiki.rendering.internal.macro.dashboard.DashboardMacro

A C D E G I M O R S