com.sssw.portal.api
Interface EbiOptionInfo

All Superinterfaces:

Cloneable, EbiElement, EbiFrameworkElement, Serializable

All Known Subinterfaces:

EbiComponentOptionInfo

public interface EbiOptionInfo

extends EbiFrameworkElement

This provides information about an option's descriptor information

Field Summary

static String

EL_PORTAL_OPTION option element type

Method Summary

String	getOptionDescription(EbiPortalContext context) Gets the option's description.
String	getOptionDisplayName(EbiPortalContext context) Gets the option's display name.
String[]	getOptionHideStates(EbiPortalContext context) Gets the list of states indicating when this option should not be included on the title bar
String	getOptionID() Gets the option's unique id
String[]	getOptionImageNames(EbiPortalContext context) Gets the list of image names for this option
String	getOptionImageValue(EbiPortalContext context, String imageName, boolean replace) Gets a specific image URI for a given iamge name
String	getOptionLink(EbiPortalContext context, boolean replace) Gets the option's link.
String	getOptionLinkTarget(EbiPortalContext context) Gets the option's link target.
String	getOptionText(EbiPortalContext context) Gets the option's text.
String	getOptionToolTip(EbiPortalContext context) Gets the tool tip for the option
boolean	showByDefault(EbiPortalContext context) boolean indicating if this option should be included by default

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_OPTION

public static final String EL_PORTAL_OPTION

option element type

Method Detail

getOptionID

public String getOptionID()

Gets the option's unique id

Returns:

the option's id

showByDefault

public boolean showByDefault(EbiPortalContext context)

boolean indicating if this option should be included by default

Returns:

boolean indicating if this option should be included by default

Since:

v5.0

getOptionDisplayName

public String getOptionDisplayName(EbiPortalContext context)

Gets the option's display name.

Parameters:

context -

Returns:

the option's display name

getOptionDescription

public String getOptionDescription(EbiPortalContext context)

Gets the option's description.

Parameters:

context -

Returns:

the option's description

getOptionImageValue

public String getOptionImageValue(EbiPortalContext context,
                                  String imageName,
                                  boolean replace)

Gets a specific image URI for a given iamge name

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. If the replace is false this method will not perform runtime substitutions. The result is simply the actual string that is in the descriptor for this particular element.

Parameters:

context -

imageName -

replace -

Returns:

the image URI

getOptionHideStates

public String[] getOptionHideStates(EbiPortalContext context)

Gets the list of states indicating when this option should not be included on the title bar

Parameters:

context -

Returns:

an array of state names where the option should be hidden

Since:

v4.0

getOptionImageNames

public String[] getOptionImageNames(EbiPortalContext context)

Gets the list of image names for this option

Parameters:

context -

Returns:

an array of image names that this option uses.

getOptionToolTip

public String getOptionToolTip(EbiPortalContext context)

Gets the tool tip for the option

Parameters:

context -

Returns:

the string to display as a tooltip.

getOptionLink

public String getOptionLink(EbiPortalContext context,
                            boolean replace)

Gets the option's link.

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. If replace is false this method will not perform runtime substitutions. The result is simply the actual string that is in the descriptor for this particular element.

Parameters:

context -

replace -

if true the string will be run through the runtime replacement mechanism, if false the raw value stored in the option descriptor will be returned

Returns:

the option's link

Since:

v4.0

getOptionLinkTarget

public String getOptionLinkTarget(EbiPortalContext context)

Gets the option's link target.

Parameters:

context -

Returns:

the option's link target

getOptionText

public String getOptionText(EbiPortalContext context)

Gets the option's text. Used if no image is specified. If no text is specified or image, then the display name is used.

Parameters:

context -

Returns:

the option's text