org.sakaiproject.service.legacy.site
Interface SitePage

All Superinterfaces:
Edit, Entity, Serializable
All Known Implementing Classes:
BaseSitePage

public interface SitePage
extends Edit, Serializable

A Site Page is grouping of tools in a Site.

Author:
Sakai Software Development Team

Field Summary
static int LAYOUT_DOUBLE_COL
          Layout value for a double column layout.
static String[] LAYOUT_NAMES
           
static int LAYOUT_SINGLE_COL
          Layout value for a single column layout.
static ResourceBundle rb
          The layouts in human readable form (localized)
 
Fields inherited from interface org.sakaiproject.service.legacy.entity.Entity
SEPARATOR
 
Method Summary
 ToolConfiguration addTool()
          Add a new tool to the page.
 ToolConfiguration addTool(Tool reg)
          Add a new tool to the page, initialized to the tool registration information provided.
 Site getContainingSite()
          Access the site in which this page lives.
 int getLayout()
           
 String getLayoutTitle()
           
 String getSiteId()
           
 String getSkin()
           
 String getTitle()
           
 ToolConfiguration getTool(String id)
          Access a tool on this page by id.
 List getTools()
           
 List getTools(int col)
           
 Collection getTools(String[] toolIds)
          Get all the tools placed in the site on this page that are of any of these tool ids.
 boolean isPopUp()
           
 void moveDown()
          Move this page one step towards the end of the order of pages in this site.
 void moveUp()
          Move this page one step towards the start of the order of pages in this site.
 void removeTool(ToolConfiguration tool)
          Remove a tool from this page.
 void setLayout(int layout)
          Set the layout for this page.
 void setPopup(boolean popup)
          Set the popup status for this page.
 void setTitle(String title)
          Set the display title of this page.
 
Methods inherited from interface org.sakaiproject.service.legacy.entity.Edit
getPropertiesEdit, isActiveEdit
 
Methods inherited from interface org.sakaiproject.service.legacy.entity.Entity
getId, getProperties, getReference, getReference, getUrl, getUrl, toXml
 

Field Detail

LAYOUT_SINGLE_COL

public static final int LAYOUT_SINGLE_COL
Layout value for a single column layout.

See Also:
Constant Field Values

LAYOUT_DOUBLE_COL

public static final int LAYOUT_DOUBLE_COL
Layout value for a double column layout.

See Also:
Constant Field Values

rb

public static final ResourceBundle rb
The layouts in human readable form (localized)


LAYOUT_NAMES

public static final String[] LAYOUT_NAMES
Method Detail

getTitle

public String getTitle()
Returns:
The human readable Title of this SitePage.

getLayout

public int getLayout()
Returns:
the layout for this page.

getLayoutTitle

public String getLayoutTitle()
Returns:
the layout title for this page.

getTools

public List getTools()
Returns:
The List (ToolConfiguration) of tools on this page.

getTools

public List getTools(int col)
Returns:
The List (ToolConfiguration) of tools on this column (0 based) of this page.

getTools

public Collection getTools(String[] toolIds)
Get all the tools placed in the site on this page that are of any of these tool ids.

Returns:
A Collection (ToolConfiguration) of all the tools placed in the site on this page that are of this tool id (may be empty).

getSkin

public String getSkin()
Returns:
the skin to use for this page.

getSiteId

public String getSiteId()
Returns:
the site id for this page.

isPopUp

public boolean isPopUp()
Returns:
true if page should open in new window.

getTool

public ToolConfiguration getTool(String id)
Access a tool on this page by id.

Parameters:
id - The tool id.
Returns:
The tool on this page with this id, or null if not found.

getContainingSite

public Site getContainingSite()
Access the site in which this page lives.

Returns:
the site in which this page lives.

setTitle

public void setTitle(String title)
Set the display title of this page.

Parameters:
title - The new title.

setLayout

public void setLayout(int layout)
Set the layout for this page.

Parameters:
layout - The new layout.

setPopup

public void setPopup(boolean popup)
Set the popup status for this page.

Parameters:
popup - The new popup status.

addTool

public ToolConfiguration addTool()
Add a new tool to the page.

Returns:
the ToolConfigurationEdit object for the new tool.

addTool

public ToolConfiguration addTool(Tool reg)
Add a new tool to the page, initialized to the tool registration information provided.

Parameters:
reg - The tool registration information used to initialize the tool.
Returns:
the ToolConfigurationEdit object for the new tool.

removeTool

public void removeTool(ToolConfiguration tool)
Remove a tool from this page.

Parameters:
tool - The tool to remove.

moveUp

public void moveUp()
Move this page one step towards the start of the order of pages in this site.


moveDown

public void moveDown()
Move this page one step towards the end of the order of pages in this site.