com.sssw.portal.api
Interface EbiLayoutInfo

All Superinterfaces:

Cloneable, EbiElement, EbiFrameworkElement, Serializable

public interface EbiLayoutInfo

extends EbiFrameworkElement

Value object for layout information

Field Summary

static String

EL_PORTAL_LAYOUT layout element type

Method Summary

String	getLayoutDefinitionFormat() Gets the format of the layout definition.
String	getLayoutDefinitionID() Gets the identifier of the file containing the actual definition
String	getLayoutDescription() Gets the description of the layout
String	getLayoutDescription(EbiPortalContext context) Gets the localized description of the layout
String	getLayoutDisplayName() Gets the display name of teh layout.
String	getLayoutDisplayName(EbiPortalContext context) Gets the localized display name of the layout.
String	getLayoutID() Gets the layout's unique identifier
String[]	getLayoutListRoles() Gets the list of roles that can see this layout in a select list
String	getLayoutPreviewImage() Gets the URL of the preview image which represents the layout
String	getLayoutPreviewImage(EbiPortalContext context) Gets the URL of the preview image which represents the layout
String[]	getLayoutRunRoles() Gets the list of roles that can run this layout

Methods implemented from interface com.sssw.fw.api.EbiFrameworkElement

getElementUUID, getLastModified, getLastModifiedBy, isEqualTo, isReadOnly, resetReadOnly, setLastModified, setLastModifiedBy, setReadOnly

Methods implemented from interface com.sssw.fw.api.EbiElement

getType

Field Detail

EL_PORTAL_LAYOUT

public static final String EL_PORTAL_LAYOUT

layout element type

Since:

v4.0

Method Detail

getLayoutDescription

public String getLayoutDescription()

Gets the description of the layout

Returns:

the description of the layout

Since:

v4.0

getLayoutDescription

public String getLayoutDescription(EbiPortalContext context)

Gets the localized description of the layout

locale comes from the http request off of the portal context

Parameters:

context - the portal context which carries the locale

Returns:

the description of the layout

Since:

v5.0

getLayoutDisplayName

public String getLayoutDisplayName()

Gets the display name of teh layout.

Returns:

the display name of the layout.

Since:

v4.0

getLayoutDisplayName

public String getLayoutDisplayName(EbiPortalContext context)

Gets the localized display name of the layout.

locale comes from the http request off of the portal context

Parameters:

context - the portal context which carries the locale

Returns:

the localized display name of the layout.

Since:

v5.0

getLayoutID

public String getLayoutID()

Gets the layout's unique identifier

Returns:

the layout's identifier

Since:

v4.0

getLayoutPreviewImage

public String getLayoutPreviewImage(EbiPortalContext context)

Gets the URL of the preview image which represents the layout

Since the string may include substitution strings based on runtime information the context is required. The returned result is the result of runtime substitutions being perfromed on the original string set in teh descriptor.

Parameters:

context - the portal context

Returns:

a URL pointin to the image

Since:

v4.0

getLayoutPreviewImage

public String getLayoutPreviewImage()

Gets the URL of the preview image which represents the layout

This method does not perform runtime substitutions. The result is simply the actual string that is in the descriptor for this particular element.

Returns:

a URL pointing to the image

Since:

v4.0

See Also:

EbiLayoutInfo.getLayoutPreviewImage(EbiPortalContext)

getLayoutDefinitionID

public String getLayoutDefinitionID()

Gets the identifier of the file containing the actual definition

Returns:

layout definitions if (i.e. file name)

Since:

v4.0

getLayoutDefinitionFormat

public String getLayoutDefinitionFormat()

Gets the format of the layout definition. Possible values are "text/xml" or "text/xhtml"

Returns:

string representing the format of the layout definition. This value will determine how a layout is rendered by the presentaiton manager.

Since:

v4.0

getLayoutRunRoles

public String[] getLayoutRunRoles()

Gets the list of roles that can run this layout

Returns:

array of role names

Since:

v4.0

getLayoutListRoles

public String[] getLayoutListRoles()

Gets the list of roles that can see this layout in a select list

Returns:

array of role names

Since:

v4.0