Versions Compared

Old Version 2

changes.mady.by.user Christoph Meier

Saved on

compared with

New Version 3

changes.mady.by.user Christoph Meier

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt

These are the essential interfaces and classes in the Magnolia API.

 See also full API Javadoc.


Table of Contents

Advanced Tables - Table Plus
border0
columnStylesborder: 3px solid white,border: 3px solid white,border: 3px solid white,border: 3px solid white
rowStylesborder: 3px solid white,border: 3px solid white,
heading0
multiplefalse
enableHeadingAttributesfalse
enableSortingfalse
classconfluenceTable no-border
enableHighlightingfalse
UI App framework
UI framework
Rendering and templating
Core Node2Bean Commands JCR utilities
Module management Filter chain Context
JCR

App framework

  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.ui.api.app.App
    renderTypeasynchronous
    : Main interface for apps. Apps are started and managed by the 
    Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.ui.api.app.AppController
    renderTypeasynchronous
    .
  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.ui.api.app.AppDescriptor
    renderTypeasynchronous
    : Describes an app.
  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.ui.api.app.SubApp
    renderTypeasynchronous
    : Represents a view open in a tab within an app.
  • Javadoc resource link
    classNameinfo.magnolia.ui.api.app.SubAppDescriptor
    renderTypeasynchronous
    . Describes a subapp.
  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.ui.api.app.AppContext
    renderTypeasynchronous
    . Provides functionality used by an app to interact with the Magnolia shell.
    • sendLocalMessage(Message message). Sends a message to the current user.
    • sendUserMessage(String user, Message message). Sends a message to a named user. 
    • broadcastMessage(Message message). Sends a message to all users.
  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.ui.api.app.SubAppContext
    renderTypeasynchronous
    . Provides functionality used by a sub app to interact with the Magnolia shell.
  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.ui.contentapp.ContentApp
    renderTypeasynchronous
    . Extends the BaseApp by the ability to open a choose dialog.
  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.ui.contentapp.browser.BrowserSubApp
    renderTypeasynchronous
    . Base implementation of a content subApp.
  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.ui.contentapp.browser.BrowserSubAppDescriptor
    renderTypeasynchronous
    . Describes a browser subapp.
  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.ui.contentapp.detail.DetailSubApp
    renderTypeasynchronous
    . Base implementation of an item subApp.
  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.ui.contentapp.detail.DetailSubAppDescriptor
    renderTypeasynchronous
    . Descriptor for Item subApps. Holds the form definition to build a form and needed fields to create a new node.

UI framework

The UI Framework is a collection of components for building the user interface in apps.

UI context

  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.ui.api.context.UiContext
    renderTypeasynchronous
    . Represents a UI context and allows components, views and presenters to interact with the context that contains them.

Workbench

  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.ui.workbench.definition.WorkbenchDefinition
    renderTypeasynchronous
    . Defines a workbench. Contains all elements which define a workbench configuration.
  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.ui.workbench.WorkbenchView
    renderTypeasynchronous
    . Displays a workbench.
  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.ui.workbench.tree.TreePresenter
    renderTypeasynchronous
    . Responsible for creating, configuring and updating a tree of items according to the workbench definition.
  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.ui.workbench.list.ListPresenter
    renderTypeasynchronous
    . Responsible for creating, configuring and updating a list of items according to the workbench definition.
  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.ui.workbench.thumbnail.ThumbnailPresenter
    renderTypeasynchronous
    . Responsible for creating, configuring and updating a thumbnail grid of items according to the workbench definition.
  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.ui.workbench.column.definition.ColumnDefinition
    renderTypeasynchronous
    . Defines a column in a workbench.
  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.ui.workbench.column.definition.ColumnFormatter
    renderTypeasynchronous
    . Defines how a column's value is displayed in the UI.

Action

  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.ui.api.action.Action
    renderTypeasynchronous
    . An action is executed in response to user interaction with the UI. For instance clicking on an item in a menu.
  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.ui.api.action.ActionDefinition
    renderTypeasynchronous
    . Action definitions are used to configure actions in many parts of the UI. The definition holds a name which is used to identify the action within a certain scope, for instance within a sub app.

Action bar

  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.ui.actionbar.definition.ActionbarDefinition
    renderTypeasynchronous
    . The definition for an action bar, made of sections and groups of actions.

Form

  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.ui.form.definition.FormDefinition
    renderTypeasynchronous
    . Defines a form.

  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.ui.form.definition.TabDefinition
    renderTypeasynchronous
    . Defines a tab within a form. Holds a list of fields contained in this tab.
  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.ui.form.field.definition.FieldDefinition
    renderTypeasynchronous
    . Defines a field within a dialog.
  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.ui.form.field.factory.FieldFactory
    renderTypeasynchronous
    . Responsible for creating Vaadin fields based on their FieldDefinition.
  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.ui.form.validator.definition.FieldValidatorDefinition
    renderTypeasynchronous
    . Defines a validator for field values.

Location and navigation

  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.ui.api.location.Location
    renderTypeasynchronous
    . Represents a location within the application, such as the open view and the selected item.
  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.ui.api.location.LocationController
    renderTypeasynchronous
    . Manages the user's location in the application and controls location changes.

Shell

  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.ui.api.shell.Shell5.6
    renderTypeasynchronous
    . Decouples the presenters and the Vaadin application. Provides methods to show messages and configuration dialogs.

Message

  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.ui.api.message.Message5.6
    renderTypeasynchronous
    . Models a message.
  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.ui.framework.message.MessagesManager
    renderTypeasynchronous
    . Manages user messages.

Event

  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.event.EventBus
    renderTypeasynchronous
    . Fires events to a set of registered handlers.
  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.ui.api.event.ContentChangedEvent
    renderTypeasynchronous
    . Event fired when content is changed in a workspace. Holds an itemId of an item that is related to the changes made. If the change was a deletion the itemId is the parent of the deleted item. If something was added the itemId is for the new item.

Context

Context is an abstraction layer representing the environment of the current process which can be a request process, a scheduled task or a command execution in the workflow. The context provides access to the most important components such as hierarchy managers jcr session, current user, context attributes and parameters, response object and so on. The context is initialized at the beginning of each process. Context attributes will have a different meaning based on the environment. In case of a request, the attributes are request attributes and request parameters. Magnolia implements context using a thread-local class.

  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.context.MgnlContext
    renderTypeasynchronous
    . This static helper class is the programmer's entry point to work with the current context.
    • getInstance() Returns the current context.
    • getUser() Returns the current user.
    • getJCRSession(String workspacename). Returns a JCR session to the provided workspace.
    • getAttribute(name) Returns a named context attribute. In case of a request, this can be a request parameter, request attribute or session attribute.
    • getWebContext() Returns the Web context if the current thread is processing a request.
    • getAggregationState().
  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.context.WebContext
    renderTypeasynchronous
    . Context interface specialized for servlet requests; knows about HttpServletRequest and HttpServletResponse. Should be used as little as possible as it makes the calling code dependent on the servlet API. Use MgnlContext instead if possible.
    • getRequest() Returns the current servlet request object.
    • getResponse() Returns the current servlet response object.
  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.cms.core.AggregationState
    renderTypeasynchronous
    . Contains information about the current request and rendering process. It is mostly initialized by the Aggregator filter.
    • getOriginalURI() Original URI is the URI as requested by the client.
    • getCurrentURI() URI as mapped by Magnolia at a given point in processing. This value is for instance changed by the i18n filter, virtual URI mapping etc.
    • getMainContentNode() The content with which we start the rendering process. In general this is the page node.
    • getCurrentContentNode() The content that is processed at the moment. First this is typically the page, then a component and so on.

Rendering and templating

  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.rendering.engine.RenderingEngine
    renderTypeasynchronous
    . Entry point for the rendering.

    • render(javax.jcr.Node content, OutputProvider out) Renders the content with its assigned template.

    • render(javax.jcr.Node content, RenderableDefinition definition, Map<String,Object> contextObjects, OutputProvider out) Uses a specific RenderableDefinition to render the content and exposes the given context objects to the template script.

  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.rendering.template.RenderableDefinition
    renderTypeasynchronous
    . Abstract rendering definition used for templates and components.
    • getName() Name of the template definition.
    • getRenderType() Defines the renderer to use. For instance JSP or Freemarker.
  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.rendering.template.TemplateDefinition
    renderTypeasynchronous
    . A RenderableDefinition which supports editing in the page editor and can define their areas.
    • getDialog()
  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.rendering.template.AreaDefinition
    renderTypeasynchronous
  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.rendering.model.RenderingModel
    renderTypeasynchronous
    . The model used in the rendering process. It is instantiated for each rendering and ties the current content and rendering definition together. Concrete classes provide helper methods used in the template script. The execute method is executed before the rendering starts, a useful place to execute any business logic. The model is available in the template script under the named model.
    • getParent() Parent model. Most often the model of the page rendering.
    • getNode() The content node tied to this model.
    • getContent() Map representation of the content node tied to this model.

    • getDefinition() The renderable (template, area or component) tied to this model.

    • execute() Called after all properties were set.

  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.rendering.renderer.Renderer
    renderTypeasynchronous
    . Responsible for generating the actual response from request data and a template. A typical JSP implementation will simply forward the request to the JSP through request dispatcher. You can bind a specific implementation to a template type.

    • render(RenderingContext ctx, Map<String,Object> contextObjects) Called by RenderingEngine after it has setup the RenderingContext.

  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.rendering.context.RenderingContext
    renderTypeasynchronous
    . Provides all information needed in the rendering process.
  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.jcr.util.ContentMap
    renderTypeasynchronous
    . Map based representation of JCR content. This class is used in template scripts to allow notations like content.<property name>. It first tries to read a property with name (key) and, if not present, checks for the presence of a child node. Special property names map to JCR methods:
    • @name
    • @id
    • @path
    • @level
    • @nodeType
  • Templating functions
    Children Display
    pageTemplating functions
    first9
  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.templating.functions.TemplatingFunctions
    renderTypeasynchronous
    . An object that exposes methods useful for templates. The object is exposed to template scripts as cmsfn.
    • children(javax.jcr.Node content)
    • parent(javax.jcr.Node content)
    • isEditMode()
    • isPublicInstance()
    • language()
  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.link.LinkUtil
    renderTypeasynchronous
    . Utility methods for link transformations and handling.
    • createLink(javax.jcr.Node node)
    • createAbsoluteLink(javax.jcr.Node node)
    • makePathRelative(String url, String absolutePath)
  • Javadoc resource link
    rangeHigherVersion3.1
    classNameinfo.magnolia.module.templatingkit.templates.category.TemplateCategory
    renderTypeasynchronous
    . Each template has a category like home, section or content.
  • Javadoc resource link
    rangeHigherVersion3.1
    classNameinfo.magnolia.module.templatingkit.sites.Site
    renderTypeasynchronous
    . Site configuration Java bean. Default site configuration merged with the user-defined site.
    • getI18n()
    • getTheme()
    • getVariations()

Commands

  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.commands.CommandsManager
    renderTypeasynchronous
  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.commands.chain.Command
    renderTypeasynchronous

Filter chain

  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.cms.filters.MgnlFilter
    renderTypeasynchronous
    . Interface for filters managed by Magnolia, exposing support for the bypass mechanism.
  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.cms.filters.AbstractMgnlFilter
    renderTypeasynchronous
    . A Magnolia filter configured in the config repository. This filter is bypassable.

Module management

  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.module.ModuleRegistry
    renderTypeasynchronous
    . Holds instances and definitions of modules.
  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.module.ModuleVersionHandler
    renderTypeasynchronous
    . Provides deltas to be applied to install/update/uninstall modules. A module that needs to handle its own install/updates should provide an implementation of this interface.
  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.module.ModuleLifecycle
    renderTypeasynchronous
    . Manages the lifecyle of an installed instance of a Magnolia Module. Implementing this interface is optional.

JCR

Session

  • Session
    • getNode(java.lang.String absPath). Returns the node at the specified absolute path in the workspace.
    • getNodeByIdentifier(java.lang.String id) Returns the node specified by the given identifier.
    • save(). Validates all pending changes currently recorded in this Session.

Node

  • Node. Represents a node in the repository.
    • getNode(java.lang.String relPath).  Returns the node at relPath relative to this node.

    • getNodes() Returns all child nodes of this node accessible through the current Session.

    • getNodes(java.lang.String namePattern) Gets all child nodes of this node accessible through the current Session that match namePattern.

    • getProperty(java.lang.String relPath) Returns the property at relPath relative to this node.

    • setProperty(java.lang.String name, Value value) Sets the single-value property of this node called name to the specified value.

  • Property. A Propertyobject represents the smallest granularity of content storage.
    • getLong()
    • getString()
    • getBinary()

JCR utilities

  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.jcr.util.NodeUtil
    renderTypeasynchronous
    . Utility methods to collect data from JCR repository.
  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.jcr.util.PropertyUtil
    renderTypeasynchronous
    . Property-related utility methods.
  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.jcr.util.SessionUtil
    renderTypeasynchronous
    . Session-related utility methods.
  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.jcr.nodebuilder.NodeBuilder
    renderTypeasynchronous
    . Entry point for using the node builder API. Also see the 
    Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.nodebuilder.task.NodeBuilderTask
    renderTypeasynchronous
     and 
    Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.nodebuilder.task.ModuleNodeBuilderTask
    renderTypeasynchronous
     classes for usage of the node builder API in 
    Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.module.ModuleVersionHandler
    renderTypeasynchronous
    .
  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.jcr.decoration.ContentDecorator
    renderTypeasynchronous
    . Applies custom behavior in a graph of JCR objects by wrapping objects. Allows for expressing the logic in a single place.
  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.jcr.util.NodeTypes
    renderTypeasynchronous
    . Magnolia-defined node types and their properties and convenience methods.
    • Javadoc resource link
      rangeHigherVersion5.6
      classNameinfo.magnolia.jcr.util.NodeTypes.Created
      renderTypeasynchronous

      • getCreated(javax.jcr.Node node) Returns the creation date of a node or null if creation date isn't set.

Node2Bean

  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.jcr.node2bean.Node2BeanProcessor
    renderTypeasynchronous
    . Transforms nodes to beans or maps. The transformer is use to resolve classes or to instantiate beans.
  • Javadoc resource link
    rangeHigherVersion5.6
    classNameinfo.magnolia.jcr.node2bean.Node2BeanTransformer
    renderTypeasynchronous
    . Contract for transformation from node to java beans.