org.alfresco.web.bean.dashboard
Class DashboardWizard

java.lang.Object
  extended by org.alfresco.web.bean.dialog.BaseDialogBean
      extended by org.alfresco.web.bean.wizard.BaseWizardBean
          extended by org.alfresco.web.bean.dashboard.DashboardWizard
All Implemented Interfaces:
java.io.Serializable, IDialogBean, IWizardBean

public class DashboardWizard
extends BaseWizardBean

See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.alfresco.web.bean.dialog.BaseDialogBean
browseBean, isFinished, navigator, parameters
 
Constructor Summary
DashboardWizard()
           
 
Method Summary
 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  java.lang.String finishImpl(javax.faces.context.FacesContext context, java.lang.String outcome)
          Performs the actual processing for the wizard.
 java.util.List getAllDashlets()
           
 boolean getAllowGuestConfig()
           
 int getColumn()
           
 int getColumnCount()
           
 int getColumnDashletCount()
           
 java.util.List getColumnDashlets()
           
 int getColumnMax()
           
 javax.faces.model.SelectItem[] getColumns()
           
 java.lang.String getLayout()
           
 java.util.List getLayoutDescriptions()
           
 java.util.List getLayoutIcons()
           
 java.lang.String getSummary()
           
 void init(java.util.Map 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(java.lang.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(java.util.Map 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 java.lang.String finishImpl(javax.faces.context.FacesContext context,
                                      java.lang.String outcome)
                               throws java.lang.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:
java.lang.Exception
See Also:
BaseDialogBean.finishImpl(javax.faces.context.FacesContext, java.lang.String)

getSummary

public java.lang.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 java.lang.String getLayout()
Returns:
The currently selected layout ID - used by the Dynamic Description component

setLayout

public void setLayout(java.lang.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 java.util.List getAllDashlets()
Returns:
The SelectItem List of all available dashlets

getColumnDashlets

public java.util.List 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 java.util.List getLayoutDescriptions()
Returns:
List of UIDescription objects for the available layouts

getLayoutIcons

public java.util.List 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



Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.