org.alfresco.web.bean.dashboard
Class PageConfig

java.lang.Object
  extended by org.alfresco.web.bean.dashboard.PageConfig
All Implemented Interfaces:
java.io.Serializable

public final class PageConfig
extends java.lang.Object
implements java.io.Serializable

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

See Also:
Serialized Form

Constructor Summary
PageConfig()
          Default constructor
PageConfig(PageConfig copy)
          Copy constructor
 
Method Summary
 void addPage(org.alfresco.web.bean.dashboard.Page page)
          Add a new Page to the list
 void fromXML(DashboardsConfigElement config, java.lang.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(java.lang.String pageId)
          Get a Page with the specified page Id
 void setCurrentPage(java.lang.String pageId)
          Set the current Page for the cnfig
 java.lang.String toString()
           
 java.lang.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(java.lang.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(java.lang.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 java.lang.String toXML()
Convert this config to an XML definition which can be serialized. Example:

Returns:
XML for this config

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

fromXML

public void fromXML(DashboardsConfigElement config,
                    java.lang.String xml)
Deserialise this PageConfig instance from the specified XML stream.

Parameters:
xml -


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