com.ibm.portal.theme.plugin
Interface ThemeLinkItem

All Superinterfaces:

com.ibm.portal.ActiveFlag, org.eclipse.core.runtime.IExecutableExtension, Localized, ThemeContent, ThemeItem

All Known Implementing Classes:

DefaultThemeLinkItem

public interface ThemeLinkItem
extends ThemeItem

A theme contribution that creates a URL.

Since:

6.0

Note:

This interface is designed to be implemented by clients.

Method Summary

boolean	isNewWindow() Indicates if the URL should be opened in a new browser window or not.
com.ibm.portal.state.EngineURL	newURL() Returns the generated URL.
boolean	requiresPOST() If the URL is an action, it should be rendered as a FORM POST instead of the usual GET.

Methods inherited from interface com.ibm.portal.theme.plugin.ThemeItem

getTooltip, newIconURL

Methods inherited from interface com.ibm.portal.theme.plugin.ThemeContent

getOrdinal, init

Methods inherited from interface com.ibm.portal.ActiveFlag

isActive

Methods inherited from interface org.eclipse.core.runtime.IExecutableExtension

setInitializationData

Methods inherited from interface com.ibm.portal.Localized

getDescription, getLocales, getTitle

Method Detail

newURL

com.ibm.portal.state.EngineURL newURL()
                                      throws com.ibm.portal.state.exceptions.StateException

Returns the generated URL. If the user is not allowed access to the resource provided by the URL, a null value is returned.

Returns:

the URL or null

Throws:

com.ibm.portal.state.exceptions.StateException - if an error occurs creating the URL

requiresPOST

boolean requiresPOST()

If the URL is an action, it should be rendered as a FORM POST instead of the usual GET.

Returns:

true if the URL is an action

isNewWindow

boolean isNewWindow()

Indicates if the URL should be opened in a new browser window or not.

Returns:

true if the URL should be opened in a new window