info.magnolia.module.blossom.annotation

Annotation Type DialogFactory

@Retention(value=RUNTIME)
 @Target(value={TYPE,METHOD})
public @interface DialogFactory

Declares a class or a method to be used for creating a dialog. The unique id of the dialog is specified in the annotation.

When used on a class it is used in combination with TabFactory on its methods. All methods annotated with TabFactory will be detected and called to contribute tabs to the dialog. The ordering of tabs inside the dialog can be set using the TabOrder annotation.

For example:

 @DialogFactory("page-properties")
 @TabOrder("Content", "Meta")
 public class PagePropertiesDialog {

   @TabFactory("Content")
   public void contentTab(TabBuilder tab) {...}

   @TabFactory("Meta")
   public void metaTab(TabBuilder tab) {...}
 }
 

It can also be used on a method in a template. The method will be called to take care of the full dialog creation. Valid arguments for such a method are:

• DialogBuilder
• ConfiguredDialogDefinition
• ConfiguredFormDialogDefinition
• DialogCreationContext
• Node
• com.vaadin.data.Item
• UiConfig
• info.magnolia.dam.app.ui.config.DamConfig or info.magnolia.dam.asset.config.DamConfig
• WebContext
• Context
• User
• MgnlUser

For example:

 @DialogFactory("page-properties")
 public void pageProperties(DialogBuilder dialog) {...}
 

You can use I18nBasename to specify which resource bundle should be used for localization of the dialogs label and its fields.

Since:

1.0

See Also:

TabFactory, TabOrder, Template, DialogCreationContext

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value Id of the dialog.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	label Label of the dialog.

Element Detail

value

public abstract String value

Id of the dialog.

label

public abstract String label

Label of the dialog.

Default:

""