org.apache.pluto.internal.impl
Class InternalPortletWindowImpl

java.lang.Object
  extended by org.apache.pluto.internal.impl.InternalPortletWindowImpl
All Implemented Interfaces:
InternalPortletWindow, PortletWindow

public class InternalPortletWindowImpl
extends java.lang.Object
implements InternalPortletWindow

Implementation of InternalPortletWindow interface.


Constructor Summary
InternalPortletWindowImpl(javax.servlet.ServletContext context, PortletWindow portletWindow)
          Constructs an internal portlet window that wraps a portlet window.
 
Method Summary
 java.lang.String getContextPath()
          Retrieve the context path in which the Portlet resides.
 PortletWindowID getId()
          Retrieve this windows unique id which will be used to communicate back to the referencing portal.
 PortletWindow getOriginalPortletWindow()
          Retrieve the original portlet window with which the container was invoked.
 PortletEntity getPortletEntity()
          Returns the portlet entity.
 PortletMode getPortletMode()
          Retrieve the current portlet mode for this window.
 java.lang.String getPortletName()
          Retrieve the name of the portlet as configured in the portlet.xml.
 javax.servlet.ServletContext getServletContext()
          The Context from which this window can be serviced.
 WindowState getWindowState()
          Retrieve the current window state for this window.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

InternalPortletWindowImpl

public InternalPortletWindowImpl(javax.servlet.ServletContext context,
                                 PortletWindow portletWindow)
Constructs an internal portlet window that wraps a portlet window. An internal portlet window instance is created everytime when the portlet container's doRender() or doAction() method is invoked.

Parameters:
context - the servlet context from which this window is being invoked.
portletWindow - the underlying portlet window instance.
Method Detail

getContextPath

public java.lang.String getContextPath()
Description copied from interface: PortletWindow
Retrieve the context path in which the Portlet resides.

Specified by:
getContextPath in interface PortletWindow
Returns:
context path

getPortletName

public java.lang.String getPortletName()
Description copied from interface: PortletWindow
Retrieve the name of the portlet as configured in the portlet.xml.

Specified by:
getPortletName in interface PortletWindow
Returns:
the name of the portlet.

getWindowState

public WindowState getWindowState()
Description copied from interface: PortletWindow
Retrieve the current window state for this window.

Specified by:
getWindowState in interface PortletWindow
Returns:
the current window state.

getPortletMode

public PortletMode getPortletMode()
Description copied from interface: PortletWindow
Retrieve the current portlet mode for this window.

Specified by:
getPortletMode in interface PortletWindow
Returns:
the current portlet mode.

getId

public PortletWindowID getId()
Description copied from interface: PortletWindow
Retrieve this windows unique id which will be used to communicate back to the referencing portal.

Specified by:
getId in interface PortletWindow
Returns:
unique id.

getServletContext

public javax.servlet.ServletContext getServletContext()
Description copied from interface: InternalPortletWindow
The Context from which this window can be serviced.

Specified by:
getServletContext in interface InternalPortletWindow
Returns:
the associated servlet context.

getPortletEntity

public PortletEntity getPortletEntity()
Description copied from interface: InternalPortletWindow
Returns the portlet entity. The return value cannot be NULL.

Specified by:
getPortletEntity in interface InternalPortletWindow
Returns:
the portlet entity

getOriginalPortletWindow

public PortletWindow getOriginalPortletWindow()
Description copied from interface: InternalPortletWindow
Retrieve the original portlet window with which the container was invoked.

Specified by:
getOriginalPortletWindow in interface InternalPortletWindow
Returns:
the original portlet window.


Copyright © 2003-2009 Apache Software Foundation. All Rights Reserved.