com.centrasite.control.ext.welcome.standard
Class WelcomePage

java.lang.Object
  extended by com.centrasite.control.ext.welcome.standard.WelcomePage
All Implemented Interfaces:
IWelcomePage

public class WelcomePage
extends java.lang.Object
implements IWelcomePage


Constructor Summary
WelcomePage()
           
 
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.util.Locale getLocale()
          Get Locale of this welcome page
 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
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WelcomePage

public WelcomePage()
Method Detail

getTitle

public java.lang.String getTitle()
Description copied from interface: IWelcomePage
Get the title of this welcome page.

Specified by:
getTitle in interface IWelcomePage
Returns:
The title of this welcome page.

getTooltip

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

Specified by:
getTooltip in interface IWelcomePage
Returns:
The tooltip.

getTitleStyle

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

Specified by:
getTitleStyle in interface IWelcomePage
Returns:
The style of the title in css2 notation.

getSubTitle

public java.lang.String getSubTitle()
Description copied from interface: IWelcomePage
Get the subtitle of this welcome page.

Specified by:
getSubTitle in interface IWelcomePage
Returns:
The subtitle of this welcome page.

getSubTitleTooltip

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

Specified by:
getSubTitleTooltip in interface IWelcomePage
Returns:
The tooltip.

getSubTitleStyle

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

Specified by:
getSubTitleStyle in interface IWelcomePage
Returns:
The style of the subtitle in css2 notation.

getImage

public java.lang.String getImage()
Description copied from interface: IWelcomePage
Get the path to an image shown next to title and subtitle.

Specified by:
getImage in interface IWelcomePage
Returns:
The path to an image.

getHeaderBackgroundImage

public java.lang.String getHeaderBackgroundImage()
Description copied from interface: IWelcomePage
Get the path to an image shown as background of this welcome page.

Specified by:
getHeaderBackgroundImage in interface IWelcomePage
Returns:
The path to an image.

getBottomBackgroundImage

public java.lang.String getBottomBackgroundImage()
Description copied from interface: IWelcomePage
Get the path to an image shown as background of this welcome page.

Specified by:
getBottomBackgroundImage in interface IWelcomePage
Returns:
The path to an image.

isSearchVisible

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

Specified by:
isSearchVisible in interface IWelcomePage
Returns:
True if visible, otherwise false

getSearchBackgroundImage

public java.lang.String getSearchBackgroundImage()
Description copied from interface: IWelcomePage
Get the path to an image shown as background of the search box.

Specified by:
getSearchBackgroundImage in interface IWelcomePage
Returns:
The path to an image.

setLocale

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

Specified by:
setLocale in interface IWelcomePage

getLocale

public java.util.Locale getLocale()
Get Locale of this welcome page

Returns:
The locale of this welcome page

setActionContext

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

Specified by:
setActionContext in interface IWelcomePage

getWidgets

public IWidget[] getWidgets()
Description copied from interface: IWelcomePage
Get up to 10 widgets of this welcome page.

Specified by:
getWidgets in interface IWelcomePage
Returns:
Max. 10 widgets for this welcome page.