com.centrasite.control.ext.welcome.interfaces
Interface IActionItem

All Superinterfaces:
IItem
All Known Implementing Classes:
AbstractActionItem, AdvancedSearchItem, AssetCatalogItem, CentraSiteCommunityItem, DateFormatItem, DeveloperCommunityItem, InboxItem, KeywordSearchItem, LanguageItem, MyFavoriteItem, OnlineDocumentationItem, UserPreferencesItem

public interface IActionItem
extends IItem

Interface to control the basic behavior of an action contained in a widget (ISingleColumnWidget) of a welcome page (IWelcomePage). An IActionItem is in HTML terms a link with title and image. The execute method will be called when clicking on the link.


Method Summary
 void execute()
          Execute this action
 java.lang.String getImage()
          Get the path to an image shown next to title.
 java.lang.String getTitle()
          Get the title of this item.
 java.lang.String getTooltip()
          Get the tooltip of this item.
 void setActionContext(com.centrasite.control.ActionContext actionContext)
          Set ActionContext for this welcome action.
 void setLocale(java.util.Locale locale)
          Set locale for this welcome action.
 
Methods inherited from interface com.centrasite.control.ext.welcome.interfaces.IItem
getStyle, getWidget, setWidget
 

Method Detail

getTitle

java.lang.String getTitle()
Get the title of this item.

Returns:
The title.

getTooltip

java.lang.String getTooltip()
Get the tooltip of this item.

Returns:
The tooltip.

getImage

java.lang.String getImage()
Get the path to an image shown next to title.

Returns:
The path to an image.

execute

void execute()
Execute this action


setLocale

void setLocale(java.util.Locale locale)
Set locale for this welcome action.


setActionContext

void setActionContext(com.centrasite.control.ActionContext actionContext)
Set ActionContext for this welcome action.