org.alfresco.web.bean.dashboard

Class PageConfig

java.lang.Object

org.alfresco.web.bean.dashboard.PageConfig

All Implemented Interfaces:

Serializable

public final class PageConfig
extends Object
implements Serializable

Describes the config for the Pages in a user Dashboard. Multiple Pages are supported.

Author:

Kevin Roast

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PageConfig() Default constructor
PageConfig(PageConfig copy) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	addPage(org.alfresco.web.bean.dashboard.Page page) Add a new Page to the list
void	fromXML(DashboardsConfigElement config, String xml) Deserialise this PageConfig instance from the specified XML stream.
org.alfresco.web.bean.dashboard.Page	getCurrentPage()
org.alfresco.web.bean.dashboard.Page	getPage(String pageId) Get a Page with the specified page Id
void	setCurrentPage(String pageId) Set the current Page for the cnfig
String	toString()
String	toXML() Convert this config to an XML definition which can be serialized.

Methods inherited from class java.lang.Object

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

Constructor Detail

PageConfig

public PageConfig()

Default constructor

PageConfig

public PageConfig(PageConfig copy)

Copy constructor

Parameters:

copy - PageConfig to copy

Method Detail

getCurrentPage

public org.alfresco.web.bean.dashboard.Page getCurrentPage()

Returns:

The current page in the config

setCurrentPage

public void setCurrentPage(String pageId)

Set the current Page for the cnfig

Parameters:

pageId - ID of the page to set as current

addPage

public void addPage(org.alfresco.web.bean.dashboard.Page page)

Add a new Page to the list

Parameters:

page - Page to add

getPage

public org.alfresco.web.bean.dashboard.Page getPage(String pageId)

Get a Page with the specified page Id

Parameters:

pageId - Of the page to return

Returns:

Page or null if not found

toXML

public String toXML()

Convert this config to an XML definition which can be serialized. Example:

Returns:

XML for this config

toString

public String toString()

Overrides:

toString in class Object

fromXML

public void fromXML(DashboardsConfigElement config,
                    String xml)

Deserialise this PageConfig instance from the specified XML stream.

Parameters:

xml -