com.novell.afw.portlet.api
Interface EbiPortletStyle

public interface EbiPortletStyle

Represents a style (xsl stylesheet to be applied) to the portlet's XML output used to render the portlet. The interface corresponds to and is populated from the the //portlet/style tag in the portlet's descriptor.

Since:

v5.0

Method Summary

String	getDataDefinition() Returns the URI to the data definition file for transcoding
String	getDisplayName(Locale locale) Returns a localized display name of the style.
String	getName() Returns the name of the style.
EbiPortletUserAgent	getUserAgent(String deviceName) Returns the user agent (EbiPortletUserAgent) having the deviceName passed in, or null if no user agent with the name specified exists.
Collection	getUserAgents() Returns a collection of all user agents (EbiPortletUserAgent) defined for this style.

Method Detail

getUserAgents

public Collection getUserAgents()

Returns a collection of all user agents (EbiPortletUserAgent) defined for this style. A user agent maps to a browser or other internet device making a request. At least one user agent will always be in the collection returned.

Returns:

Collection of EbiPortletUserAgent objects, one for each device defined.

Since:

v5.0

getUserAgent

public EbiPortletUserAgent getUserAgent(String deviceName)

Returns the user agent (EbiPortletUserAgent) having the deviceName passed in, or null if no user agent with the name specified exists.

Parameters:

deviceName - String name of the device to return.

Returns:

An EbiPortletUserAgent object representing the device with the deviceName indicated, or null if a user agent with the specified deviceName was not found.

Since:

v5.0

getName

public String getName()

Returns the name of the style. This should be unique per portlet.

Returns:

String name of the portlet's style.

Since:

v5.0

getDisplayName

public String getDisplayName(Locale locale)

Returns a localized display name of the style. Display names are localized by specifying the xml:lang attribute for the display-name tag. When a locale is passed in, a search for the most appropriate locale is done if an exact match can not be found. See section PLT.21.8.1 of the portlet spec for more details on how descriptor values are localized.

Parameters:

locale - Locale for which to return the display-name, or null to mean the default.

Returns:

String with the localized display-name.

Since:

v5.0

getDataDefinition

public String getDataDefinition()

Returns the URI to the data definition file for transcoding

Returns:

String with the URI as entered in the descriptor, or null if no URI is defined

Since:

v5.0