Page tree
Skip to end of metadata
Go to start of metadata

Customizing an existing app is easier and less time consuming than developing a new app from scratch. A secondary benefit is that existing app configurations are updated frequently with new releases of Magnolia. When you extend configuration, new configuration installed with Magnolia releases don't override your configuration and any goodies they introduce are available to you automatically. On the other hand, Magnolia code is open source. Because you can customize anything, you can also customize in ways that makes the app hard to update. Here are some guidelines for customizing the right way.

Extend, don't copy. Add your customizations to the original app configuration directly, or better yet, extend the original.

Add custom actions

Add your own custom actions to existing apps. Actions are configured is under subapps. The example below substitutes a direct publishing action that bypasses the approval workflow in the Pages app.

Node name

Value

 modules


 pages


 apps


 pages


 subApps


 browser


 actions


 activate


 catalog

versioned

 class

info.magnolia.ui.framework.action.ActivationActionDefinition

 command

activate

 icon

icon-publish

 label

Publish

Change columns

Change the columns displayed in the tree and lists views. You can find column configuration under the content views (tree, list, search). Here is an example from the Assets app. The columns displayed in the tree view of the app are the same as in the list view, except the path column is left out. The benefit of extending to an existing configuration and overriding specific values is that you always know exactly what you have customized.

Node nameValue
 workbench

 contentViews


 tree


 columns


 path


 enabled

false

 extends

../../list/columns

 class

info.magnolia.ui.workbench.tree.TreePresenterDefinition

 list


 columns


 asset


 path


 title


 status


 moddate


Launch custom dialogs

Change an action definition to launch your own dialog instead of the one provided by default. Identify the dialog in the dialogName property. Here is an example of referencing a dialog in the Contacts app. The dialog definition is not shown here but you can find it in the same module.

Node nameValue
 browser

 actions


 addFolder


 editFolder


 class

info.magnolia.ui.framework.action.OpenEditDialogActionDefinition

 dialogName

contacts:folder

 icon

icon-edit

 label

Rename folder

Change fields in a dialog

Add fields to dialogs or change existing fields. See Dialog definition.

Create an editor component

Editor is a component that edits content. It typical displays a form just like a dialog does. The difference between dialogs and editors is that an editor is contained in a subapp. You can open as many subapps as you like, which means that you can edit many items at the same time. This is not possible with a dialog. In a dialog you edit only one item at a time.

Node nameValue

 modules


 dam-app


 apps


 assets


 subApps


 browser


 detail


 editor


 form


 actions


 nodeType


(warning) Magnolia 5.2

Node nameValue

 modules


 dam


 apps


 assets


 subApps


 browser


 detail


 editor


 form


 actions


 nodeType


 workspace

dam

Write your own views

What if you want to write you own view? Say you wish to replace info.magnolia.sample.app.main.ContentDisplayView with a new class that you have written called com.acme.sample.app.main.ContentDisplayViewAcme.

The right way to implement your custom view is to create a new module and extend the existing module. In the new module's descriptor (sample-app-acme.xml), point to the existing one. Change only the one <component> element to point to the new implementation.

Original ContentDisplayView defined in the sample app
<id>app-sample</id>
   <component>
    <type>info.magnolia.sample.app.main.ContentDisplayView</type>
    <implementation>info.magnolia.sample.app.main.ContentDisplayViewImpl</implementation>
  </component>
</components>
Overriding the standard view in your own module
<id>acme-app-sample</id>
   <component>
    <type>info.magnolia.sample.app.main.ContentDisplayView</type>
    <implementation>com.acme.sample.app.main.ContentDisplayViewImplAcme</implementation>
  </component>
</components>