com.atlassian.confluence.plugins.gadgets.metadata
Class GadgetMacroParameter

java.lang.Object
  extended by com.atlassian.confluence.macro.browser.beans.MacroParameter
      extended by com.atlassian.confluence.plugins.gadgets.metadata.GadgetMacroParameter
All Implemented Interfaces:
Serializable

public class GadgetMacroParameter
extends MacroParameter

Adds additional metadata for gadgets : this is only for non hidden prefs.

See Also:
Serialized Form

Constructor Summary
GadgetMacroParameter(com.atlassian.gadgets.spec.UserPrefSpec pref)
          Creates a macro parameter from the provided UserPrefSpec.
 
Method Summary
 Message getDescription()
           
 Message getDisplayName()
           
 boolean isShared()
          This results in the macro browser copying the value of this parameter into the value of another parameter.
 
Methods inherited from class com.atlassian.confluence.macro.browser.beans.MacroParameter
addAlias, addEnumValue, addOption, addOptions, getAliases, getDefaultValue, getEnumValues, getName, getOptions, getType, isHidden, isMultiple, isRequired, setDescription, setDisplayName, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

GadgetMacroParameter

public GadgetMacroParameter(com.atlassian.gadgets.spec.UserPrefSpec pref)
Creates a macro parameter from the provided UserPrefSpec. Note that only the values from enums are provided, not the keys. This is due to lack of support in the MacroBrowser despite the addOption() method.

Method Detail

isShared

public boolean isShared()
This results in the macro browser copying the value of this parameter into the value of another parameter. All gadget parameters should be copied across so this is always true.


getDisplayName

public Message getDisplayName()
Overrides:
getDisplayName in class MacroParameter

getDescription

public Message getDescription()
Overrides:
getDescription in class MacroParameter


Copyright © 2003-2012 Atlassian. All Rights Reserved.