info.magnolia.module.blossom.dialog
Class TabBuilder

java.lang.Object
  info.magnolia.module.blossom.dialog.TabBuilder

public class TabBuilder
extends Object

Builder object used to populate a tab with controls. For a complete reference of dialog control settings see: http://documentation.magnolia-cms.com/reference/dialogs/controls.html.

Since:

0.5

See Also:

Dialog, DialogTab

Constructor Summary

TabBuilder(DialogCreationContext context, info.magnolia.cms.gui.dialog.DialogTab tab)

TabBuilder(DialogCreationContext context, String label)

Method Summary

info.magnolia.cms.gui.dialog.DialogButtonSet	addCheckbox(String name, String label, String buttonLabel)
info.magnolia.cms.gui.dialog.DialogControlImpl	addControl(String controlType, String name, String label, String description)
info.magnolia.cms.gui.dialog.DialogDate	addDate(String name, String label, String description)
info.magnolia.cms.gui.dialog.DialogDate	addDateAndTime(String name, String label, String description)
info.magnolia.cms.gui.dialog.DialogEdit	addEdit(String name, String label, String description)
info.magnolia.module.fckeditor.dialogs.FckEditorDialog	addFckEditor(String name, String label, String description)
info.magnolia.cms.gui.dialog.DialogFile	addFile(String name, String label, String description)
info.magnolia.cms.gui.dialog.DialogHidden	addHidden(String name, String value)
info.magnolia.cms.gui.dialog.DialogInclude	addInclude(String file)
info.magnolia.cms.gui.dialog.DialogLink	addLink(String name, String label, String description)
info.magnolia.cms.gui.dialog.DialogMultiSelect	addMultiSelect(String name, String label, String description)
info.magnolia.cms.gui.dialog.DialogPassword	addPassword(String name, String label, String description)
info.magnolia.cms.gui.dialog.DialogButtonSet	addRadio(String name, String label, Map<String,String> options, String defaultValue) Convenience-method to create a radio-buttonset from a map of options.
info.magnolia.cms.gui.dialog.DialogSelect	addSelect(String name, String label, String description, Collection<String> options)
info.magnolia.cms.gui.dialog.DialogSelect	addSelect(String name, String label, String description, Map<String,String> options)
info.magnolia.cms.gui.dialog.DialogStatic	addStatic(String text)
info.magnolia.cms.gui.dialog.DialogEdit	addTextArea(String name, String label, String description, int rows)
info.magnolia.cms.gui.dialog.DialogUUIDLink	addUuidLink(String name, String label, String description)
void	addValidator(ValidationCallback validator)
DialogCreationContext	getContext()
info.magnolia.cms.gui.dialog.Dialog	getDialog()
info.magnolia.cms.gui.dialog.DialogTab	getTab()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TabBuilder

public TabBuilder(DialogCreationContext context,
                  String label)

TabBuilder

public TabBuilder(DialogCreationContext context,
                  info.magnolia.cms.gui.dialog.DialogTab tab)

Method Detail

getTab

public info.magnolia.cms.gui.dialog.DialogTab getTab()

getDialog

public info.magnolia.cms.gui.dialog.Dialog getDialog()

getContext

public DialogCreationContext getContext()

addValidator

public void addValidator(ValidationCallback validator)

addEdit

public info.magnolia.cms.gui.dialog.DialogEdit addEdit(String name,
                                                       String label,
                                                       String description)

addTextArea

public info.magnolia.cms.gui.dialog.DialogEdit addTextArea(String name,
                                                           String label,
                                                           String description,
                                                           int rows)

addFckEditor

public info.magnolia.module.fckeditor.dialogs.FckEditorDialog addFckEditor(String name,
                                                                           String label,
                                                                           String description)

addSelect

public info.magnolia.cms.gui.dialog.DialogSelect addSelect(String name,
                                                           String label,
                                                           String description,
                                                           Map<String,String> options)

addSelect

public info.magnolia.cms.gui.dialog.DialogSelect addSelect(String name,
                                                           String label,
                                                           String description,
                                                           Collection<String> options)

addLink

public info.magnolia.cms.gui.dialog.DialogLink addLink(String name,
                                                       String label,
                                                       String description)

addUuidLink

public info.magnolia.cms.gui.dialog.DialogUUIDLink addUuidLink(String name,
                                                               String label,
                                                               String description)

addCheckbox

public info.magnolia.cms.gui.dialog.DialogButtonSet addCheckbox(String name,
                                                                String label,
                                                                String buttonLabel)

addRadio

public info.magnolia.cms.gui.dialog.DialogButtonSet addRadio(String name,
                                                             String label,
                                                             Map<String,String> options,
                                                             String defaultValue)

Convenience-method to create a radio-buttonset from a map of options.

Parameters:

name - name of nodeData

label - label

options - map of options where key is label and value is value. Use a sorted Map-implementation like LinkedHashMap if order is important.

defaultValue - the value of the item that should be selected by default. Must be in the map to be selected.

Returns:

addHidden

public info.magnolia.cms.gui.dialog.DialogHidden addHidden(String name,
                                                           String value)

addStatic

public info.magnolia.cms.gui.dialog.DialogStatic addStatic(String text)

addDate

public info.magnolia.cms.gui.dialog.DialogDate addDate(String name,
                                                       String label,
                                                       String description)

addDateAndTime

public info.magnolia.cms.gui.dialog.DialogDate addDateAndTime(String name,
                                                              String label,
                                                              String description)

addFile

public info.magnolia.cms.gui.dialog.DialogFile addFile(String name,
                                                       String label,
                                                       String description)

addPassword

public info.magnolia.cms.gui.dialog.DialogPassword addPassword(String name,
                                                               String label,
                                                               String description)

addMultiSelect

public info.magnolia.cms.gui.dialog.DialogMultiSelect addMultiSelect(String name,
                                                                     String label,
                                                                     String description)

addInclude

public info.magnolia.cms.gui.dialog.DialogInclude addInclude(String file)

addControl

public info.magnolia.cms.gui.dialog.DialogControlImpl addControl(String controlType,
                                                                 String name,
                                                                 String label,
                                                                 String description)