org.alfresco.web.bean.dashboard

Class DashboardWizard

java.lang.Object

org.alfresco.web.bean.dialog.BaseDialogBean

org.alfresco.web.bean.wizard.BaseWizardBean

org.alfresco.web.bean.dashboard.DashboardWizard

All Implemented Interfaces:

Serializable, IDialogBean, IWizardBean

public class DashboardWizard
extends BaseWizardBean

Author:

Kevin Roast

See Also:

Serialized Form

Field Summary

Fields inherited from class org.alfresco.web.bean.dialog.BaseDialogBean

browseBean, isFinished, navigator, parameters

Constructor Summary

Constructors

Constructor and Description
DashboardWizard()

Method Summary

Modifier and Type	Method and Description
void	addDashlets(javax.faces.event.ActionEvent event) Action event handler called to Add dashlets to the selection for a column
void	dashletDown(javax.faces.event.ActionEvent event) Action event called to move a dashlet down the column list
void	dashletUp(javax.faces.event.ActionEvent event) Action event called to move a dashlet up the column list
protected String	finishImpl(javax.faces.context.FacesContext context, String outcome) Performs the actual processing for the wizard.
List<javax.faces.model.SelectItem>	getAllDashlets()
boolean	getAllowGuestConfig()
int	getColumn()
int	getColumnCount()
int	getColumnDashletCount()
List<javax.faces.model.SelectItem>	getColumnDashlets()
int	getColumnMax()
javax.faces.model.SelectItem[]	getColumns()
String	getLayout()
List<UIDescription>	getLayoutDescriptions()
List<UIListItem>	getLayoutIcons()
String	getSummary()
void	init(Map<String,String> parameters) Initialises the dialog bean
void	removeDashlet(javax.faces.event.ActionEvent event) Action handler called to Remove a dashlet from the selection for a column
void	setColumn(int column) Set the index of the column being edited in the columns wizard page.
void	setDashboardManager(DashboardManager dashboardManager)
void	setLayout(String layout) Set the currently selected layout ID

Methods inherited from class org.alfresco.web.bean.wizard.BaseWizardBean

back, buildSummary, getBackButtonLabel, getDefaultCancelOutcome, getDefaultFinishOutcome, getFinishButtonLabel, getNextButtonDisabled, getNextButtonLabel, getStepDescription, getStepTitle, next

Methods inherited from class org.alfresco.web.bean.dialog.BaseDialogBean

cancel, doPostCommitProcessing, finish, formatErrorMessage, getActionsConfigId, getActionsContext, getAdditionalButtons, getCancelButtonLabel, getCheckOutCheckInService, getContainerDescription, getContainerSubTitle, getContainerTitle, getDictionaryService, getErrorMessageId, getErrorOutcome, getFileFolderService, getFinishButtonDisabled, getMoreActionsConfigId, getNamespaceService, getNodeService, getRuleService, getSearchService, getTransactionService, isFinished, restored, setBrowseBean, setDictionaryService, setFileFolderService, setNamespaceService, setNavigator, setNodeService, setSearchService

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.alfresco.web.bean.dialog.IDialogBean

cancel, finish, getActionsConfigId, getActionsContext, getAdditionalButtons, getCancelButtonLabel, getContainerDescription, getContainerSubTitle, getContainerTitle, getFinishButtonDisabled, getMoreActionsConfigId, isFinished, restored

Constructor Detail

DashboardWizard

public DashboardWizard()

Method Detail

setDashboardManager

public void setDashboardManager(DashboardManager dashboardManager)

Parameters:

dashboardManager - The dashboardManager to set.

init

public void init(Map<String,String> parameters)

Description copied from interface: IDialogBean

Initialises the dialog bean

Specified by:

init in interface IDialogBean

Overrides:

init in class BaseDialogBean

Parameters:

parameters - Map of parameters for the dialog

See Also:

BaseDialogBean.init(java.util.Map)

finishImpl

protected String finishImpl(javax.faces.context.FacesContext context,
                            String outcome)
                     throws Exception

Description copied from class: BaseDialogBean

Performs the actual processing for the wizard. NOTE: This method is called within the context of a transaction so no transaction handling is required

Specified by:

finishImpl in class BaseDialogBean

Parameters:

context - FacesContext

outcome - The default outcome

Returns:

The outcome

Throws:

Exception

See Also:

BaseDialogBean.finishImpl(javax.faces.context.FacesContext, java.lang.String)

getSummary

public String getSummary()

Returns:

Returns the summary data for the wizard.

getAllowGuestConfig

public boolean getAllowGuestConfig()

Returns:

true to allow the Guest user to configure the dashboard, false otherwise

getLayout

public String getLayout()

Returns:

The currently selected layout ID - used by the Dynamic Description component

setLayout

public void setLayout(String layout)

Set the currently selected layout ID

getColumnCount

public int getColumnCount()

Returns:

the number of columns in the selected page layout

getColumnMax

public int getColumnMax()

Returns:

the number of components per column supported in the selected page layout

getColumns

public javax.faces.model.SelectItem[] getColumns()

Returns:

the array of UI select items representing the columns that can be configured

getColumn

public int getColumn()

Returns:

the index of the column being edited in the columns wizard page

setColumn

public void setColumn(int column)

Set the index of the column being edited in the columns wizard page. This value is set when the Columns drop-down value is changed by the user.

Parameters:

column - Column index

getAllDashlets

public List<javax.faces.model.SelectItem> getAllDashlets()

Returns:

The SelectItem List of all available dashlets

getColumnDashlets

public List<javax.faces.model.SelectItem> getColumnDashlets()

Returns:

the List of SelectItem objects representing the dashlets displayed in the currently selected column.

getColumnDashletCount

public int getColumnDashletCount()

Returns:

the number of dashlets currently displayed in the selected column

getLayoutDescriptions

public List<UIDescription> getLayoutDescriptions()

Returns:

List of UIDescription objects for the available layouts

getLayoutIcons

public List<UIListItem> getLayoutIcons()

Returns:

the List of UIListItem objects representing the Layout icons

addDashlets

public void addDashlets(javax.faces.event.ActionEvent event)

Action event handler called to Add dashlets to the selection for a column

removeDashlet

public void removeDashlet(javax.faces.event.ActionEvent event)

Action handler called to Remove a dashlet from the selection for a column

dashletUp

public void dashletUp(javax.faces.event.ActionEvent event)

Action event called to move a dashlet up the column list

dashletDown

public void dashletDown(javax.faces.event.ActionEvent event)

Action event called to move a dashlet down the column list