net.xoetrope.xui
Interface XPageDisplay

All Known Implementing Classes:

XApplicationContext

public interface XPageDisplay

An interface used by page containers to display a page. XApplet is a known implementation

Copyright (c) Xoetrope Ltd., 1998-2004
License: see license.txt $Revision: 2.4 $

Method Summary

XContentHolder	addTarget(java.lang.String name, java.lang.Object constraint, int preferredWidth, int preferredHeight, java.util.Hashtable params) Add a new frame or target area to a frameset
java.lang.Object	displayDecoration(PageSupport page, java.lang.String constraint) Display a window decoration, for example a toolbar
java.lang.Object	displayPage(PageSupport page) Called when a page needs to be displayed.
java.lang.Object	displayPage(PageSupport page, java.lang.String target) Called when a page needs to be displayed.
java.lang.Object	displayPage(PageSupport page, java.lang.String target, java.lang.Object attributes) Called when a page needs to be displayed.
void	doLayout() Update the page display layout
java.lang.Object	findTarget(java.lang.String name) Get a named frame/target from the current frameset
int	getNumTargets() Get the number of frame/target from the current frameset
java.lang.Object	getTarget(int idx) Get the target for a page display request
void	removeAllTargets() Remove all frames/targets from the current frameset
void	setupFrameset(java.util.Hashtable params) Setup frameset.

Method Detail

doLayout

void doLayout()

Update the page display layout

displayPage

java.lang.Object displayPage(PageSupport page)

Called when a page needs to be displayed. Updates the default target area

Parameters:

page - the new page

Returns:

the page being displayed

displayPage

java.lang.Object displayPage(PageSupport page,
                             java.lang.String target)

Called when a page needs to be displayed.

Parameters:

page - the new page

target - the name of the target area to update

Returns:

the page being displayed

displayPage

java.lang.Object displayPage(PageSupport page,
                             java.lang.String target,
                             java.lang.Object attributes)

Called when a page needs to be displayed.

Parameters:

page - the new page

target - the name of the target area to update

attribs - attributes for use by the new page / taregt

Returns:

the page being displayed

displayDecoration

java.lang.Object displayDecoration(PageSupport page,
                                   java.lang.String constraint)

Display a window decoration, for example a toolbar

Parameters:

page - the new page

constraint - a value controlling how and where the decoration is displayed, this value is application type specific

Returns:

the page being displayed

addTarget

XContentHolder addTarget(java.lang.String name,
                         java.lang.Object constraint,
                         int preferredWidth,
                         int preferredHeight,
                         java.util.Hashtable params)

Add a new frame or target area to a frameset

Parameters:

name - the frame name

constraint - the BorderlayoutConstraint

preferredWidth - the preferred width

preferredHeight - the preferred height

params - extra parameters for the target

Returns:

the new target

removeAllTargets

void removeAllTargets()

Remove all frames/targets from the current frameset

findTarget

java.lang.Object findTarget(java.lang.String name)

Get a named frame/target from the current frameset

Parameters:

name - the name of the frame

Returns:

the target frame

getTarget

java.lang.Object getTarget(int idx)

Get the target for a page display request

Parameters:

idx - the target area

Returns:

the container to be updated

getNumTargets

int getNumTargets()

Get the number of frame/target from the current frameset

Returns:

the number of target frames

setupFrameset

void setupFrameset(java.util.Hashtable params)

Setup frameset. This method is called prior to the addition of any target areas in the framset and prior to the display of any pages

Parameters:

params - the framset parameters if any