站内搜索: 请输入搜索关键词
当前页面: 在线文档首页 > JBOSS Portal 2.2 API 英文版文档

HeaderContentPlugin - JBOSS Portal 2.2 API 英文版文档


org.jboss.portal.core.plugins.page
Class HeaderContentPlugin

java.lang.Object
  extended byorg.jboss.portal.core.plugins.page.HeaderContentPlugin
All Implemented Interfaces:
AdapterPlugin, Plugin

public class HeaderContentPlugin
extends java.lang.Object
implements AdapterPlugin

Plugin (for the portlet container) to add declarative header content injection to portlets.

This plugin allows a portlet to declare header-content data to be injected into the page header (via a jsp tag).

See Also:
AdapterPlugin, HeaderContentMetaData

Nested Class Summary
static class HeaderContentPlugin.HeaderElement
          representation of a header element.
 
Constructor Summary
HeaderContentPlugin()
           
 
Method Summary
 void destroy()
           
 java.lang.Class getAdaptedClass()
          Return the classname adapted by the adapter.
 java.lang.Object getAdapter()
          Return the adapter instance.
 java.lang.String getContent()
          Get the content to inject into the header.
 java.util.List getHeaderElements()
          Get the list of header elements to inject.
 void init(PluginContext pluginContext)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HeaderContentPlugin

public HeaderContentPlugin()
Method Detail

getAdaptedClass

public java.lang.Class getAdaptedClass()
Description copied from interface: AdapterPlugin
Return the classname adapted by the adapter.

Specified by:
getAdaptedClass in interface AdapterPlugin
See Also:
org.jboss.portal.common.plugin.AdapterPlugin#getAdaptedClassName()

getAdapter

public java.lang.Object getAdapter()
Description copied from interface: AdapterPlugin
Return the adapter instance.

Specified by:
getAdapter in interface AdapterPlugin
See Also:
AdapterPlugin.getAdapter()

init

public void init(PluginContext pluginContext)
Specified by:
init in interface Plugin
Parameters:
pluginContext -
See Also:
Plugin.init(PluginContext)

destroy

public void destroy()
Specified by:
destroy in interface Plugin
See Also:
Plugin.destroy()

getHeaderElements

public java.util.List getHeaderElements()
Get the list of header elements to inject.

Returns:
the list of header elements

getContent

public java.lang.String getContent()
Get the content to inject into the header.

The content is built from the list of header elements. This method is ment to be a convenience method. It allows to directly get the stringified content, instead of iterating through the header elements individually.

Returns:
the content to inject