Java Doc for SitePage.java in » ERP-CRM-Financial » sakai » org » sakaiproject » site » api » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » ERP CRM Financial » sakai » org.sakaiproject.site.api

Source Cross Reference

Class Diagram

Java Document (Java Doc)

org.sakaiproject.site.api .SitePage

All known Subclasses:   org.sakaiproject.site.impl .BaseSitePage,
SitePage
public interface SitePage extends Edit,Serializable(Code)

A Site Page is grouping of tools in a Site.

Field Summary
final public static int LAYOUT_DOUBLE_COL
     Layout value for a double column layout.
final public static int LAYOUT_SINGLE_COL
     Layout value for a single column layout.

Method Summary
public ToolConfiguration addTool()
     Add a new tool to the page.
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.
public ToolConfiguration addTool(String toolId)
     Add a new tool to the page, initialized to the tool id provided.
Parameters:
  toolId - The tool id for this tool.
public Site getContainingSite()
     Access the site in which this page lives.
public int getLayout()
     the layout for this page.
public String getLayoutTitle()
     the layout title for this page.
public int getPosition()
     get the 0 based index position of the page within the site's pages.
public String getSiteId()
     the site id for this page.
public String getSkin()
     the skin to use for this page.
public String getTitle()
     The human readable Title of this SitePage.
public ToolConfiguration getTool(String id)
     Access a tool on this page by id.
Parameters:
  id - The tool id.
public List getTools()
     The List (ToolConfiguration) of tools on this page.
public List getTools(int col)
     The List (ToolConfiguration) of tools on this column (0 based) of this page.
Collection getTools(String[] toolIds)
     Get all the tools placed in the site on this page that are of any of these tool ids.
Parameters:
  tooldIds - The tool id array (String, such as sakai.chat, not a tool configuration / placement uuid) to search for.
public boolean isPopUp()
     true if page should open in new window.
public void moveDown()
     Move this page one step towards the end of the order of pages in this site.
public void moveUp()
     Move this page one step towards the start of the order of pages in this site.
public void removeTool(ToolConfiguration tool)
     Remove a tool from this page.
public void setLayout(int layout)
     Set the layout for this page.
public void setPopup(boolean popup)
     Set the popup status for this page.
public void setPosition(int pos)
     Move this page to a specific (0 based index) position within the site's pages.
public void setTitle(String title)
     Set the display title of this page.

Field Detail
LAYOUT_DOUBLE_COL
final public static int LAYOUT_DOUBLE_COL(Code)
Layout value for a double column layout.

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

Method Detail
addTool
public ToolConfiguration addTool()(Code)
Add a new tool to the page. the ToolConfigurationEdit object for the new tool.

addTool
public ToolConfiguration addTool(Tool reg)(Code)
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. the ToolConfigurationEdit object for the new tool.

addTool
public ToolConfiguration addTool(String toolId)(Code)
Add a new tool to the page, initialized to the tool id provided.
Parameters:
  toolId - The tool id for this tool. the ToolConfigurationEdit object for the new tool.

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

getLayout
public int getLayout()(Code)
the layout for this page.

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

getPosition
public int getPosition()(Code)
get the 0 based index position of the page within the site's pages.

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

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

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

getTool
public ToolConfiguration getTool(String id)(Code)
Access a tool on this page by id.
Parameters:
  id - The tool id. The tool on this page with this id, or null if not found.

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

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

getTools
Collection getTools(String[] toolIds)(Code)
Get all the tools placed in the site on this page that are of any of these tool ids.
Parameters:
  tooldIds - The tool id array (String, such as sakai.chat, not a tool configuration / placement uuid) to search for. A Collection (ToolConfiguration) of all the tools placed in the site on this page that are of this tool id (may be empty).

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

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

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

removeTool
public void removeTool(ToolConfiguration tool)(Code)
Remove a tool from this page.
Parameters:
  tool - The tool to remove.

setLayout
public void setLayout(int layout)(Code)
Set the layout for this page.
Parameters:
  layout - The new layout.

setPopup
public void setPopup(boolean popup)(Code)
Set the popup status for this page.
Parameters:
  popup - The new popup status.

setPosition
public void setPosition(int pos)(Code)
Move this page to a specific (0 based index) position within the site's pages.

setTitle
public void setTitle(String title)(Code)
Set the display title of this page.
Parameters:
  title - The new title.

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.