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

All Known Implementing Classes:
WelcomePage

public interface IWelcomePage

Interface to control the basic behavior of the Welcome Page. A welcome page has a header area with title, subtitle, etc. and a body area which contains one or more so-called widgets (IWidget).


Method Summary
 java.lang.String getBottomBackgroundImage()
          Get the path to an image shown as background of this welcome page.
 java.lang.String getHeaderBackgroundImage()
          Get the path to an image shown as background of this welcome page.
 java.lang.String getImage()
          Get the path to an image shown next to title and subtitle.
 java.lang.String getSearchBackgroundImage()
          Get the path to an image shown as background of the search box.
 java.lang.String getSubTitle()
          Get the subtitle of this welcome page.
 java.lang.String getSubTitleStyle()
          Get the style of the subtitle of this welcome page.
 java.lang.String getSubTitleTooltip()
          Get the tooltip for subtitle of this welcome page.
 java.lang.String getTitle()
          Get the title of this welcome page.
 java.lang.String getTitleStyle()
          Get the style of the title of this welcome page.
 java.lang.String getTooltip()
          Get the tooltip for this welcome page.
 IWidget[] getWidgets()
          Get up to 10 widgets of this welcome page.
 boolean isSearchVisible()
          Is the search box of this welcome page visible.
 void setActionContext(com.centrasite.control.ActionContext actionContext)
          Set ActionContext for this welcome page.
 void setLocale(java.util.Locale locale)
          Set Locale for this welcome page.
 

Method Detail

getTitle

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

Returns:
The title of this welcome page.

getTitleStyle

java.lang.String getTitleStyle()
Get the style of the title of this welcome page.

Returns:
The style of the title in css2 notation.

getSubTitle

java.lang.String getSubTitle()
Get the subtitle of this welcome page.

Returns:
The subtitle of this welcome page.

getSubTitleStyle

java.lang.String getSubTitleStyle()
Get the style of the subtitle of this welcome page.

Returns:
The style of the subtitle in css2 notation.

getTooltip

java.lang.String getTooltip()
Get the tooltip for this welcome page.

Returns:
The tooltip.

getSubTitleTooltip

java.lang.String getSubTitleTooltip()
Get the tooltip for subtitle of this welcome page.

Returns:
The tooltip.

getImage

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

Returns:
The path to an image.

getHeaderBackgroundImage

java.lang.String getHeaderBackgroundImage()
Get the path to an image shown as background of this welcome page.

Returns:
The path to an image.

getBottomBackgroundImage

java.lang.String getBottomBackgroundImage()
Get the path to an image shown as background of this welcome page.

Returns:
The path to an image.

isSearchVisible

boolean isSearchVisible()
Is the search box of this welcome page visible.

Returns:
True if visible, otherwise false.

getSearchBackgroundImage

java.lang.String getSearchBackgroundImage()
Get the path to an image shown as background of the search box.

Returns:
The path to an image.

getWidgets

IWidget[] getWidgets()
Get up to 10 widgets of this welcome page.

Returns:
Max. 10 widgets for this welcome page.

setLocale

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


setActionContext

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