nextapp.echoservlet
Class WindowUI

java.lang.Object
  nextapp.echoservlet.ComponentPeer
      nextapp.echoservlet.WindowUI

All Implemented Interfaces:

java.util.EventListener, java.beans.PropertyChangeListener, java.io.Serializable, Service

public class WindowUI

extends ComponentPeer

implements java.beans.PropertyChangeListener, Service

A peer object for Windows. This class is responsible for rendering the root document of each browser window, which contains a <frameset> that references the window's content and the Controller document. Windows also contain the client model object script and additional JavaScript functions for maintaining application state.

See Also:

Serialized Form

Field Summary

private int	flags
static int	MENU_BAR
private static Service	SERVICE_CLIENT_MODEL_SCRIPT The service containing the ClientModel script.
private static Service	SERVICE_WINDOW_SCRIPT The service containing the window's built-in JavaScript functions.
static int	STATUS_BAR
static int	TOOL_BAR

Fields inherited from class nextapp.echoservlet.ComponentPeer

Constructor Summary

WindowUI()

Method Summary

int	getFlags() Returns the flags enabled on this window.
PaneUI	getRootPaneUI() Returns the PaneUI of the WindowUI's content.
static java.lang.String	getScriptHandleUnload() Returns a line of JavaScript code that will invoke the window unload handler.
private java.lang.String	getScriptInitClientModel() Returns the script necessary to initialize the "ClientModel" JavaScript object.
void	propertyChange(java.beans.PropertyChangeEvent e)
void	registered() Called when the component is registered.
void	service(Connection conn) Services an HTTP request.
void	setFlags(int flags) Sets the flags enabled on this window.
void	unregistered() Called when the component is unregistered.

Methods inherited from class nextapp.echoservlet.ComponentPeer

addAncillaryService, generateId, getBackground, getChildCount, getChildren, getComponent, getFont, getForeground, getId, getInstancePeer, getParent, getPeer, redraw, registerAncillaryServices, removeAncillaryService, render, setComponent, setId, setInstancePeer, unregisterAncillaryServices

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface nextapp.echoservlet.Service

getId

Field Detail

MENU_BAR

public static final int MENU_BAR

See Also:

Constant Field Values

STATUS_BAR

public static final int STATUS_BAR

See Also:

Constant Field Values

TOOL_BAR

public static final int TOOL_BAR

See Also:

Constant Field Values

SERVICE_CLIENT_MODEL_SCRIPT

private static final Service SERVICE_CLIENT_MODEL_SCRIPT

The service containing the ClientModel script.

SERVICE_WINDOW_SCRIPT

private static final Service SERVICE_WINDOW_SCRIPT

The service containing the window's built-in JavaScript functions.

flags

private int flags

Constructor Detail

WindowUI

public WindowUI()

Method Detail

getScriptHandleUnload

public static java.lang.String getScriptHandleUnload()

Returns a line of JavaScript code that will invoke the window unload handler.

Returns:

A line of JavaScript code that will invoke the window unload handler.

getRootPaneUI

public PaneUI getRootPaneUI()

Returns the PaneUI of the WindowUI's content.

Returns:

The PaneUI of the WindowUI's content.

getScriptInitClientModel

private java.lang.String getScriptInitClientModel()

Returns the script necessary to initialize the "ClientModel" JavaScript object.

Returns:

The script necessary to initialize the "ClientModel" JavaScript object.

getFlags

public int getFlags()

Returns the flags enabled on this window.

Returns:

The flags enabled on this window, which can consist of zero or more of the following values ORed together:

• MENU_BAR
• STATUS_BAR
• TOOL_BAR

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent e)

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

See Also:

PropertyChangeListener.propertyChange(PropertyChangeEvent)

registered

public void registered()

Description copied from class: ComponentPeer

Called when the component is registered. This method should be overridden if necessary.

Overrides:

registered in class ComponentPeer

See Also:

ComponentPeer.registered()

service

public void service(Connection conn)
             throws java.io.IOException

Description copied from interface: Service

Services an HTTP request. Information about the HTTP request as well as methods for issuing a response are available from the provided Connection object.

Specified by:

service in interface Service

Parameters:

conn - A Connection object which wraps HttpServletRequest and HttpServletResponse objects and provides access to the facilities of the Echo application container.

Throws:

java.io.IOException - in the event of errors related to processing the HTTP request or producing a response.

See Also:

Service.service(Connection)

setFlags

public void setFlags(int flags)

Sets the flags enabled on this window.

Parameters:

flags - The flags enabled on this window, which can consist of zero or more of the following values ORed together:

• MENU_BAR
• STATUS_BAR
• TOOL_BAR

unregistered

public void unregistered()

Description copied from class: ComponentPeer

Called when the component is unregistered. This method should be overridden if necessary.

Overrides:

unregistered in class ComponentPeer

See Also:

ComponentPeer.unregistered()