com.webmethods.portal.service.portlet

Interface IPortletTitleBar

All Superinterfaces:

IContentProvider, IContentRenderer

Deprecated.

Interface for the portlet title bar. The title bar is drawn by the portal, but the portlet can customize the title bar properties like title, title link, custom links, etc

To get the current title bar reference use IPortletBean.getPortletTitleBar(). To customize the titlebar overwrite IPortletBean.getPortletTitleBar() method.

@Deprecated
public interface IPortletTitleBar
extends IContentRenderer

Method Summary

Modifier and Type	Method and Description
void	addCustomLink(String caption, String url) Deprecated. Adds a custom link to the current list
Map<String,String>	getCustomLinks() Deprecated. Returns the current custom links map
String	getHelpLink() Deprecated.
String	getTitle() Deprecated. Returns the current portlet title
String	getTitleLink() Deprecated. Returns the current title link url
String	getWidth() Deprecated.
boolean	isToolsMenuEnabled() Deprecated. Returns whether the tools menu is enabled
void	setCustomLinks(Map<? extends String,? extends String> links) Deprecated. Sets a new portlet's custom links map
void	setTitle(String portletTitle) Deprecated. Sets a new title for the title bar
void	setToolsMenuEnabled(boolean enabled) Deprecated. Enables or disables tools menu for the portlet
void	setWidth(String value) Deprecated.

Methods inherited from interface com.webmethods.portal.service.portlet.IContentRenderer

setPortlet

Methods inherited from interface com.webmethods.portal.service.portlet.IContentProvider

getContent, getContentType, getContentTypes, isContentTypeSupported, setContentType

Method Detail

setTitle

void setTitle(String portletTitle)

Deprecated.

Sets a new title for the title bar

Parameters:

portletTitle - the new portlet title

getTitle

String getTitle()

Deprecated.

Returns the current portlet title

Returns:

the current portlet title

getTitleLink

String getTitleLink()

Deprecated.

Returns the current title link url

Returns:

the current title link url

getHelpLink

@Deprecated
String getHelpLink()

Deprecated.

setCustomLinks

void setCustomLinks(Map<? extends String,? extends String> links)

Deprecated.

Sets a new portlet's custom links map

Parameters:

links - the map of name/url link pairs

getCustomLinks

Map<String,String> getCustomLinks()

Deprecated.

Returns the current custom links map

Returns:

the current custom links map

addCustomLink

void addCustomLink(String caption,
                   String url)

Deprecated.

Adds a custom link to the current list

Parameters:

caption - the link caption

url - the link url

setWidth

@Deprecated
void setWidth(String value)

Deprecated.

getWidth

@Deprecated
String getWidth()

Deprecated.

setToolsMenuEnabled

void setToolsMenuEnabled(boolean enabled)

Deprecated.

Enables or disables tools menu for the portlet

Parameters:

enabled - false to disable the portlet's title bar tools menu

isToolsMenuEnabled

boolean isToolsMenuEnabled()

Deprecated.

Returns whether the tools menu is enabled

Returns:

true if the menu is enabled