01: package net.xoetrope.xui;
02:
03: import java.awt.Container;
04:
05: /**
06: * An interface used by page containers to display a page. XApplet is a known implementation
07: * <p>Copyright (c) Xoetrope Ltd., 1998-2004<br>
08: * License: see license.txt
09: * $Revision: 1.12 $
10: */
11: public interface XPageDisplay {
12: /**
13: * Called when a page needs to be displayed. Updates the default target area
14: * @param page the new page
15: * @return the page being displayed
16: */
17: public XPage displayPage(XPage page);
18:
19: /**
20: * Called when a page needs to be displayed.
21: * @param page the new page
22: * @param target the name of the target area to update
23: * @return the page being displayed
24: */
25: public XPage displayPage(XPage page, String target);
26:
27: /**
28: * Adds a frame to the frameset
29: * @param frame the new traget frame
30: * @param constraint the BorderLayout constraint
31: */
32: public void addTarget(XTarget frame, Object constraint);
33:
34: /**
35: * Get a named frame/target from the current frameset
36: * @param name the name of the frame
37: * @return the target frame
38: */
39: public Container findTarget(String name);
40:
41: /**
42: * Get the target for a page display request
43: * @param idx the target area
44: * @return the container to be updated
45: */
46: public Container getTarget(int idx);
47:
48: /**
49: * Get the number of frame/target from the current frameset
50: * @return the number of target frames
51: */
52: public int getNumTargets();
53: }
|