com.leafdigital.ui.api
Interface Page

All Superinterfaces:
Widget, WidgetOwner, WidgetParent

public interface Page
extends WidgetOwner, Widget, WidgetParent

This interface represents the contents of a single Page within the system.


Method Summary
 java.lang.String getTitle()
           
 void setContents(org.w3c.dom.Element e)
          Clears existing contents and sets the contents of the page based on an XML document.
 void setContents(Widget w)
          Clears existing contents and sets the contents of the page to a single widget.
 void setOnSet(java.lang.String callback)
          Sets a callback which will get called if this page is set within another one by calling setContents on the other page.
 void setTitle(java.lang.String title)
          Sets the page's title; may be used in various ways depending on where the Page is placed.
 
Methods inherited from interface com.leafdigital.ui.api.WidgetOwner
getCallbackHandler, getGroupSelected, getWidget, isCreated, setWidgetID
 
Methods inherited from interface com.leafdigital.ui.api.Widget
getID, getOwner, informClosed, isVisible, setOwner, setVisible
 
Methods inherited from interface com.leafdigital.ui.api.WidgetParent
getWidgets
 

Method Detail

setTitle

void setTitle(java.lang.String title)
Sets the page's title; may be used in various ways depending on where the Page is placed.

Parameters:
title - New title text

getTitle

java.lang.String getTitle()
Returns:
Page title

setContents

void setContents(Widget w)
Clears existing contents and sets the contents of the page to a single widget.

Parameters:
w - Desired widget

setContents

void setContents(org.w3c.dom.Element e)
Clears existing contents and sets the contents of the page based on an XML document.

Parameters:
e - XML element; must follow the appropriate format
Throws:
BugException - If there are format problems with the XML

setOnSet

@UICallback
void setOnSet(java.lang.String callback)
Sets a callback which will get called if this page is set within another one by calling setContents on the other page. Can be used to do things just before the page appears.

Parameters:
callback - Callback method name


Copyright © 2011 Samuel Marshall. All rights reserved.