public class DeviceTypeRendererComponentModuleDescriptor extends com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Renderer>
Renderer
components which associates an existing Spring configured Renderer
implementation with a particular device type. See ConversionContext.getOutputDeviceType()
for more
information about device types.
The key attribute on the descriptor identifies the name of the Renderer component in the context. The device-type element can occur multiple times.
Note that this ModuleDescriptor will not create instances of the module but instead will retrieve the named instance from the Spring context in which it exists.
The purpose of this module is to allow plugins to define new Renderer
for new output device types. For
example, the Confluence Mobile plugin may want to register a mobile specific Renderer.
Constructor and Description |
---|
DeviceTypeRendererComponentModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory) |
Modifier and Type | Method and Description |
---|---|
Set<String> |
getDeviceTypes() |
Renderer |
getModule()
Retrieve the named bean from Spring.
|
void |
init(@NonNull com.atlassian.plugin.Plugin plugin,
@NonNull org.dom4j.Element element) |
assertModuleClassImplements, checkPermissions, destroy, disabled, enabled, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getModuleClassName, getName, getParams, getPlugin, getPluginKey, getRequiredPermissions, getResourceDescriptor, getResourceDescriptors, getResourceLocation, getScopeKey, hashCode, isBroken, isEnabled, isEnabledByDefault, isSystemModule, loadClass, provideValidationRules, satisfiesMinJavaVersion, setBroken, setPlugin, toString
public DeviceTypeRendererComponentModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory)
public void init(@NonNull com.atlassian.plugin.Plugin plugin, @NonNull org.dom4j.Element element) throws com.atlassian.plugin.PluginParseException
public Renderer getModule()
getModule
in interface com.atlassian.plugin.ModuleDescriptor<Renderer>
getModule
in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Renderer>
ClassCastException
- if the bean identified by the key attribute is not of class Renderer
.Copyright © 2003–2020 Atlassian. All rights reserved.