| java.lang.Object
 com.caucho.portal.generic.GenericWindow
All known Subclasses: com.caucho.portal.generic.GenericLayoutWindow, com.caucho.portal.generic.GenericPortletWindow,
| GenericWindow | | abstract public class GenericWindow implements Window,PortletConfig(Code) | | |
| Field Summary | |
| final protected static Logger | log
|
| Method Summary | |
| public void | addInitParam(String name, String value)
Add an init-param for the portlet. | | public void | addInitParam(NameValuePair nameValuePair)
| | void | addSupportedLocale(String locale)
Add a supported locale, the default is to support all locales. | | void | addSupportedLocales(String locales)
Add supported locales with a comma separated list, the default is to
support all locales. | | public void | destroy()
| | public int | getBufferSize()
| | public ArrayList<Constraint> | getConstraints()
This implementation returns null. | | public PortletPreferences | getDefaultPreferences()
This implementation returns null. | | public int | getExpirationCache()
| | public String | getInitParameter(String name)
| | public Enumeration | getInitParameterNames()
| | protected String | getNamespace()
| | public PortletConfig | getPortletConfig()
| | public PortletContext | getPortletContext()
| | public String | getPortletName()
| | public ArrayList<PreferencesValidator> | getPreferencesValidators()
| | public Renderer | getRenderer()
| | public ResourceBundle | getResourceBundle(Locale locale)
| | public Map<String, String> | getRoleRefMap()
This implementation returns null. | | public Set<String> | getSupportedContentTypes(PortletMode portletMode)
This implementation returns null, which means that all content
types are supported. | | public Set<Locale> | getSupportedLocales()
This implementation returns null, which means that all locales are
supported. | | public void | handleConstraintFailure(RenderRequest request, RenderResponse response, ConstraintFailureEvent event)
| | public void | handleException(RenderRequest request, RenderResponse response, ExceptionEvent event)
| | public PortletMode | handlePortletModeFailure(PortletRequest request, PortletMode notAllowed)
This implementation returns PortletMode.VIEW. | | public WindowState | handleWindowStateFailure(PortletRequest request, WindowState notAllowed)
This implementation returns WindowState.NORMAL. | | public void | init(PortletContext portletContext)
| | public boolean | isPortletModeAllowed(PortletRequest request, PortletMode portletMode)
This implementation returns true. | | public boolean | isPrivate()
| | public boolean | isWindowStateAllowed(PortletRequest request, WindowState windowState)
This implementation returns true. | | protected Object | newInstance(Class targetClass, String className)
Instantiate a new instance of an object, performing checks
for validity.
The object that results from instantiating an instance of
className must be an instance of
targetClass.
Parameters:
targetClass - the class that the instantiated Object should becompatible with. | | abstract public void | processAction(PortletConnection connection)
| | abstract public void | render(PortletConnection connection)
| | public void | setBufferSize(int bufferSize)
0 disables buffering, -1 allows the portal to choose a
buffer size, a positive number indicaets a minimum buffer size. | | public void | setErrorPage(String errorPage)
Specify a location to forward to if an exception or constraint failure
occurs while rendering the portlet. | | public void | setExpirationCache(int expirationCache)
Enable caching of the response and set the expiration time in seconds. | | public void | setNamespace(String namespace)
The namespace is used to uniquely identify this usage of the portlet,
the default is "" (the empty string). | | public void | setPortletName(String portletName)
The default is the namespace. | | public void | setPortletPreferences(GenericPortletPreferences defaultPreferences)
Set the default preferences. | | public void | setPrivate(boolean isPrivate)
If true then the response is private, indicating that it contains
information that should only be provided to the current client, default is
false. | | public void | setRenderer(Renderer renderer)
A Renderer wraps decorations around the portlet, see
AbstractRenderer . | | public void | setRendererClass(String className)
| | public void | setResourceBundle(String name)
Set a resource bundle name, used to instantiate an instance of
ResourceBundleFactory. | | public void | setResourceBundleFactory(ResourceBundleFactory factory)
|
| GenericWindow | | public GenericWindow()(Code) | | |
| addInitParam | | public void addInitParam(String name, String value)(Code) | | Add an init-param for the portlet.
|
| addSupportedLocale | | void addSupportedLocale(String locale)(Code) | | Add a supported locale, the default is to support all locales.
This is an ordered list, those added first are more preferrable.
|
| addSupportedLocales | | void addSupportedLocales(String locales)(Code) | | Add supported locales with a comma separated list, the default is to
support all locales. This is an ordered list, those added first are more
preferrable.
|
| destroy | | public void destroy()(Code) | | |
| getBufferSize | | public int getBufferSize()(Code) | | |
| getDefaultPreferences | | public PortletPreferences getDefaultPreferences()(Code) | | This implementation returns null.
|
| getExpirationCache | | public int getExpirationCache()(Code) | | |
| getPortletConfig | | public PortletConfig getPortletConfig()(Code) | | |
| getPortletContext | | public PortletContext getPortletContext()(Code) | | |
| getPreferencesValidators | | public ArrayList<PreferencesValidator> getPreferencesValidators()(Code) | | |
| getSupportedContentTypes | | public Set<String> getSupportedContentTypes(PortletMode portletMode)(Code) | | This implementation returns null, which means that all content
types are supported.
|
| getSupportedLocales | | public Set<Locale> getSupportedLocales()(Code) | | This implementation returns null, which means that all locales are
supported.
|
| handlePortletModeFailure | | public PortletMode handlePortletModeFailure(PortletRequest request, PortletMode notAllowed)(Code) | | This implementation returns PortletMode.VIEW.
|
| handleWindowStateFailure | | public WindowState handleWindowStateFailure(PortletRequest request, WindowState notAllowed)(Code) | | This implementation returns WindowState.NORMAL.
|
| init | | public void init(PortletContext portletContext) throws PortletException(Code) | | |
| isPortletModeAllowed | | public boolean isPortletModeAllowed(PortletRequest request, PortletMode portletMode)(Code) | | This implementation returns true.
|
| isPrivate | | public boolean isPrivate()(Code) | | |
| isWindowStateAllowed | | public boolean isWindowStateAllowed(PortletRequest request, WindowState windowState)(Code) | | This implementation returns true.
|
| newInstance | | protected Object newInstance(Class targetClass, String className) throws IllegalArgumentException(Code) | | Instantiate a new instance of an object, performing checks
for validity.
The object that results from instantiating an instance of
className must be an instance of
targetClass.
Parameters:
targetClass - the class that the instantiated Object should becompatible with.
Parameters:
className - the String name of a class to use when instantiating theobject. a new Object |
| setBufferSize | | public void setBufferSize(int bufferSize)(Code) | | 0 disables buffering, -1 allows the portal to choose a
buffer size, a positive number indicaets a minimum buffer size. Default is
0 unless `error-page' (
GenericWindow.setErrorPage(String) has been used, then
the default is -1.
|
| setErrorPage | | public void setErrorPage(String errorPage)(Code) | | Specify a location to forward to if an exception or constraint failure
occurs while rendering the portlet. The default behaviour is
for an exception or constraint failure to propogate to the parent
window, or if there is no parent then to the servlet container.
If an exception occurs the following request attributes are set:
- com.caucho.portal.error.exception
- java.lang.Throwable
- com.caucho.portal.error.exception_type
- java.lang.Class
- com.caucho.portal.error.message
- java.lang.String
- javax.portlet.renderRequest
- javax.portlet.RenderRequest
- javax.portlet.renderResponse
- javax.portlet.RenderResponse
- javax.portlet.portletConfig
- javax.portlet.PortletConfig
If a constraint failure occurs the following request attributes are set:
- com.caucho.portal.error.constraint
- com.caucho.portal.generic.Constraint
- com.caucho.portal.error.constraint_type
- java.lang.Class
- com.caucho.portal.error.status_code
- java.lang.Integer
- javax.portlet.renderRequest
- javax.portlet.RenderRequest
- javax.portlet.renderResponse
- javax.portlet.RenderResponse
- javax.portlet.portletConfig
- javax.portlet.PortletConfig
|
| setExpirationCache | | public void setExpirationCache(int expirationCache)(Code) | | Enable caching of the response and set the expiration time in seconds. 0
(the default) means do not cache, -1 means unlimited cach time, any other
number is the number of seconds for which the response can be cached.
|
| setNamespace | | public void setNamespace(String namespace)(Code) | | The namespace is used to uniquely identify this usage of the portlet,
the default is "" (the empty string).
The namespace is important when using a portlet preferences store,
and also has an effect on the encoding of parameters.
|
| setPortletName | | public void setPortletName(String portletName)(Code) | | The default is the namespace.
|
| setPrivate | | public void setPrivate(boolean isPrivate)(Code) | | If true then the response is private, indicating that it contains
information that should only be provided to the current client, default is
false. Setting this to true has an effect on caching, if true then a
cached value
cannot be shared amongst different users and the effectiveness of caching
is greatly reduced.
|
| setResourceBundle | | public void setResourceBundle(String name)(Code) | | Set a resource bundle name, used to instantiate an instance of
ResourceBundleFactory.
|
|
|