com.atlassian.confluence.macro.browser.beans

Class MacroSummary

java.lang.Object

com.atlassian.confluence.macro.browser.beans.MacroSummary

public class MacroSummary
extends Object

Constructor Summary

Constructors

Constructor and Description
MacroSummary(String macroName, String pluginKey, MacroIcon icon, String title, String description, Set<String> aliases, Set<String> categories, boolean bodyDeprecated, boolean hidden, String alternateId, List<MacroPropertyPanelButton> buttons, boolean hasRequiredParameters, boolean isAlwaysShowConfig, String gadgetUrl)

Method Summary

Methods

Modifier and Type	Method and Description
Set<String>	getAliases() Returns aliases for this macro.
String	getAlternateId()
List<MacroPropertyPanelButton>	getButtons()
Set<String>	getCategories() Returns categories this macro should be displayed within in the Macro Browser.
Message	getDescription()
String	getGadgetUrl()
MacroIcon	getIcon()
String	getMacroName()
String	getPluginKey()
Message	getTitle()
boolean	isAlwaysShowConfig() If a macro is inserted that has required fields, we show the macro configuration dialog.
boolean	isAnyParameterRequired()
boolean	isBodyDeprecated()
boolean	isHidden()

Methods inherited from class java.lang.Object

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

Constructor Detail

MacroSummary

public MacroSummary(String macroName,
            String pluginKey,
            MacroIcon icon,
            String title,
            String description,
            Set<String> aliases,
            Set<String> categories,
            boolean bodyDeprecated,
            boolean hidden,
            String alternateId,
            List<MacroPropertyPanelButton> buttons,
            boolean hasRequiredParameters,
            boolean isAlwaysShowConfig,
            String gadgetUrl)

Method Detail

getMacroName

public String getMacroName()

getPluginKey

public String getPluginKey()

getIcon

public MacroIcon getIcon()

Returns:

the MacroIcon , containing the url string to the macro icon and whether or not the URL is relative. Can return null.

getTitle

public Message getTitle()

getDescription

public Message getDescription()

getAliases

public Set<String> getAliases()

Returns aliases for this macro.

Aliases are other macro names that can be substituted for the "main" macro name. For example "web-widget" can be used instead of "widget" for the "Widget Connector" macro. Only the "main" name is used by the macro-browser, so we use the Strings returned by this method to edit in the macro-browser those macros with an alias in their markup.

Returns:

a set of strings that are aliases of the macro name.

getCategories

public Set<String> getCategories()

Returns categories this macro should be displayed within in the Macro Browser.

Categories allow macros to be browsed instead of searched. The Macro Browser has a list view where all macros for a given category are displayed, and adding the category name to the set returned from this method displays this macro in that category list.

Returns:

a set of strings that are names of MacroCategory enum objects.

isBodyDeprecated

public boolean isBodyDeprecated()

Returns:

true if the body of the macro is deprecated (defined the macro configuration). Use this method to take precedence over the Macro.hasBody() implementation.

isHidden

public boolean isHidden()

Returns:

true if this metadata should not appear in the Macro Browser.

getAlternateId

public String getAlternateId()

getButtons

public List<MacroPropertyPanelButton> getButtons()

isAnyParameterRequired

public boolean isAnyParameterRequired()

isAlwaysShowConfig

public boolean isAlwaysShowConfig()

If a macro is inserted that has required fields, we show the macro configuration dialog. In some cases, we may want to force the configuration dialog to appear even if there are no required fields.

Returns:

true if the macro configuration dialog should appear.

getGadgetUrl

public String getGadgetUrl()