com.atlassian.jira.web.component
Class DashboardPageWebComponent.Configuration

java.lang.Object
  com.atlassian.jira.web.component.DashboardPageWebComponent.Configuration

Enclosing class:

DashboardPageWebComponent

public static final class DashboardPageWebComponent.Configuration
extends Object

Represents the configuration options available when using the DashboardPageWebComponent.

Constructor Summary

DashboardPageWebComponent.Configuration(boolean editMode, boolean enableLoginPrompt)
Full constructor.

Method Summary

static DashboardPageWebComponent.Configuration	createDefaultDashboardConfiguration(boolean edit) Returns a new instance of this class pre-set with login prompt enabled and add portlet box visible if necessary.
boolean	isEditMode() Defines whether the dashboard page is in edit mode.
boolean	isEnableLoginPrompt() Defines whether or not the login prompt will be displayed in the case that there is no logged in user.

Methods inherited from class java.lang.Object

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

Constructor Detail

DashboardPageWebComponent.Configuration

public DashboardPageWebComponent.Configuration(boolean editMode,
                                               boolean enableLoginPrompt)

Full constructor.

Parameters:

editMode - edit mode.

enableLoginPrompt - whether to show the login prompt when it is needed.

Method Detail

createDefaultDashboardConfiguration

public static DashboardPageWebComponent.Configuration createDefaultDashboardConfiguration(boolean edit)

Returns a new instance of this class pre-set with login prompt enabled and add portlet box visible if necessary.

Parameters:

edit - edit mode flag

Returns:

new instance with defaults for dashboard page

isEnableLoginPrompt

public boolean isEnableLoginPrompt()

Defines whether or not the login prompt will be displayed in the case that there is no logged in user.

Returns:

true only if the login prompt should be shown to anonymous users.

isEditMode

public boolean isEditMode()

Defines whether the dashboard page is in edit mode. Portlet moving and editing links etc. are shown in edit mode.

Returns:

true only if the configuration is in edit mode.