org.sakaiproject.service.legacy.site
Interface ToolConfiguration

All Superinterfaces:
Placement, Serializable
All Known Implementing Classes:
BaseToolConfiguration

public interface ToolConfiguration
extends Placement, Serializable

ToolConfiguration is a the placement of a tool on a site page; a placement with layout information.

Version:
$Revision: 2454 $
Author:
University of Michigan, Sakai Software Development Team

Method Summary
 SitePage getContainingPage()
          Access the SitePage in which this tool configuration lives.
 String getLayoutHints()
           
 String getPageId()
           
 int getPageOrder()
          Access the tool's order in the page.
 String getSiteId()
           
 String getSkin()
           
 void moveDown()
          Move this tool one step towards the end of the order of tools in this page.
 void moveUp()
          Move this tool one step towards the start of the order of tools in this page.
 int[] parseLayoutHints()
          If the layout hints are a row,col format, return the two numbers, else return null.
 void setLayoutHints(String hints)
          Set the layout hints.
 
Methods inherited from interface org.sakaiproject.api.kernel.tool.Placement
getConfig, getContext, getId, getPlacementConfig, getTitle, getTool, save, setTitle, setTool
 

Method Detail

getLayoutHints

public String getLayoutHints()
Returns:
the layout hints for this tool.

setLayoutHints

public void setLayoutHints(String hints)
Set the layout hints.

Parameters:
hints - The layout hints.

parseLayoutHints

public int[] parseLayoutHints()
If the layout hints are a row,col format, return the two numbers, else return null.


getSkin

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

getPageId

public String getPageId()
Returns:
the page id for this tool.

getSiteId

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

getContainingPage

public SitePage getContainingPage()
Access the SitePage in which this tool configuration lives.

Returns:
the SitePage in which this tool configuration lives.

moveUp

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


moveDown

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


getPageOrder

public int getPageOrder()
Access the tool's order in the page.

Returns:
the tool's order in the page.