Overview | Package | Class | Tree | Serialized | Deprecated | Index | Help
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES

## Package com.ibm.portal.theme.plugin.impl

This package provides default implementations of the theme extension interfaces that may be sub-classed and reused by developers.

See:
Description

Interface Summary
ThemeContentDescriptorConstants | Constants describing the xml attributes for a `DefaultThemeContent`.
ThemeItemDescriptorConstants | The constants in this interface identify the various components of the xml describing an `ThemeItem`.
ThemeJspIncludeDescriptorConstants | Constants describing the xml for declaring a `DefaultThemeJspInclude`

Class Summary
DefaultThemeContent | The default implementation of `ThemeContent`.
DefaultThemeItem | This class will retrieve the icon path for an extension.
DefaultThemeJspInclude | The default implementation of `ThemeJspInclude`.
DefaultThemeLinkItem | Creates a link to a portal page.
DefaultThemeTextItem | Generates some text to contribute to a theme extension point.

## Package com.ibm.portal.theme.plugin.impl Description

This package provides default implementations of the theme extension interfaces that may be sub-classed and reused by developers.

## Package Specification

The implementations provided here may be sub-classed and reused by developers

### Default extension points:

The table below describes the extension points included in the default theme. The `ID` field is the extension point identifier used in the plugin.xml. The `Default Implementation` field describes the interface which provides the information the default extension point requires. Type enforcement is not performed at runtime.

ID | Description | Default Implementation
com.ibm.portal.theme.plugin.MetaTagDataItems | provides components with a method of adding data to the meta tags of a page | `DefaultThemeTextItem`
com.ibm.portal.theme.plugin.Styles | provides components with a method of contributing CSS styles to the page (either a link or embedded css) | `DefaultThemeTextItem`
com.ibm.portal.theme.plugin.JavascriptItems | provides components with a method of adding javascript to a page (either a link or actual js code) | `DefaultThemeTextItem`
com.ibm.portal.theme.plugin.HorizontalPageBarItems | provides components with a method of adding jsp content to the horizontal page bar | `DefaultThemeJspInclude`
com.ibm.portal.theme.plugin.VerticalPageBarItems | provides components with a method of adding jsp content to the vertical page bar | `DefaultThemeJspInclude`
com.ibm.portal.theme.plugin.MainContextMenuItems | provides components with a method of adding an item to the main context menu | `DefaultThemeLinkItem`
com.ibm.portal.theme.plugin.PageContextMenuItems | provides components with a method of adding an item to the main context menu | `DefaultThemeLinkItem`
com.ibm.portal.theme.plugin.PortletContextMenuItems | provides components with a method of adding an item to the portlet context menu | `DefaultThemeLinkItem`
com.ibm.portal.theme.plugin.Flyouts | provides components with a method of adding a flyout to the page | `DefaultThemeJspInclude`

### Extension point definition examples:

Please note that all markup in this section is implementation specific. The parsing of the plugin.xml is handled by the implementing extension through the `setInitializationData` method.

Defining a link extension:

    <extension point="com.ibm.portal.theme.plugin.MainContextMenu">
                    <item id="AdministrationLink"
                             class="com.ibm.wps.theme.plugin.impl.DefaultThemePageLinkItemImpl"
                             title="helloworld.title"
                             description="helloworld.description"
                             tooltip="helloworld.tooltip"
                             ordinal="200"
                             contentNode="wps.Administration" / >
    </extension>

Defining a jsp include extension:

    <extension point="com.ibm.wps.plugin.theme.Flyout">
            <include id="PeopleAwareFlyout"
                        class="com.ibm.wps.theme.plugin.impl.DefaultThemeIncludeJspImpl"
                        ordinal="200"
                        jsp="PeopleFlyout.jsp" />
    </extension>

Overview | Package | Class | Tree | Serialized | Deprecated | Index | Help
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES