nextapp.echoservlet
Class ContainerPaneUI

java.lang.Object
  nextapp.echoservlet.ComponentPeer
      nextapp.echoservlet.ContainerPaneUI

All Implemented Interfaces:

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

public class ContainerPaneUI

extends ComponentPeer

implements PaneUI, java.beans.PropertyChangeListener, Service

A peer object for ContainerPanes. This class is responsible for rendering <frameset> documents to layout windows.

See Also:

Serialized Form

Field Summary

Fields inherited from class nextapp.echoservlet.ComponentPeer

Fields inherited from interface nextapp.echoservlet.PaneUI

SCROLLING_ALWAYS, SCROLLING_AUTO, SCROLLING_NEVER

Constructor Summary

ContainerPaneUI()
Creates a new ContainerPaneUI.

Method Summary

static Element	createFrameElement(Connection conn, PaneUI paneUI) Creates a <frame> element representation of a pane.
(package private) PaneUI	getForwardingPane() Returns the pane that this pane is "forwarding" requests to.
java.lang.String	getScrolling() Returns the scrolling property of the pane.
java.lang.String	getUri(Connection conn) Returns the URI from which the pane's service may be rendered.
void	propertyChange(java.beans.PropertyChangeEvent e)
void	registered() Called when the component is registered.
void	service(Connection conn) Services an HTTP request.
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.PaneUI

getId

Methods inherited from interface nextapp.echoservlet.Service

getId

Constructor Detail

ContainerPaneUI

public ContainerPaneUI()

Creates a new ContainerPaneUI.

Method Detail

createFrameElement

public static Element createFrameElement(Connection conn,
                                         PaneUI paneUI)

Creates a <frame> element representation of a pane.

Parameters:

conn - The connection the document will be rendered to.

paneUI - The paneUI to generate a frame element for.

Returns:

A frame element for the specified pane.

getForwardingPane

PaneUI getForwardingPane()

Returns the pane that this pane is "forwarding" requests to. If the container pane has more than one child pane, this method will return this. In the case where there is only one child pane, this method will return the child pane.

Returns:

The pane that this pane is "forwarding" requests to.

getScrolling

public java.lang.String getScrolling()

Description copied from interface: PaneUI

Returns the scrolling property of the pane.

Specified by:

getScrolling in interface PaneUI

Returns:

The scrolling property of the pane, one of the following values:

• SCROLLING_AUTO
• SCROLLING_ALWAYS
• SCROLLING_NEVER

See Also:

PaneUI.getScrolling()

getUri

public java.lang.String getUri(Connection conn)

Description copied from interface: PaneUI

Returns the URI from which the pane's service may be rendered.

Specified by:

getUri in interface PaneUI

Parameters:

conn - The connection from which to derive the URI.

Returns:

The URI from which the pane's service may be rendered.

See Also:

PaneUI.getUri(Connection)

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)

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.

See Also:

Service.service(Connection)

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()