WindowResult - JBOSS Portal 2.6 API 英文版文档

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jboss.portal.theme.page
Class WindowResult

java.lang.Object
  org.jboss.portal.theme.render.MarkupResult
      org.jboss.portal.theme.page.WindowResult

Direct Known Subclasses:: ModifiableWindowResult

public class WindowResult
extends MarkupResult

The window result represent the generated content of a window. It contains several kind of data :

the window title

the window content

a map of actions available for the window

Version:: $Revision: 5448 $
Author:: Julien Viet

Nested Class Summary

static class WindowResult.Action
          Represents an action that can be triggered.

Field Summary

private java.util.Map actions


private java.lang.String content


private java.lang.String headerContent


private Mode mode


static java.lang.String MODES_KEY


private Properties properties


private java.lang.String title


private java.util.Map windowProperties


private WindowState windowState


static java.lang.String WINDOWSTATES_KEY


Fields inherited from class org.jboss.portal.theme.render.MarkupResult

layoutState, layoutURI, pageName, pageProperties, portalProperties, portlets, renderSet, results, theme, themeResult

Constructor Summary

WindowResult(java.lang.String title, java.lang.String content, java.util.Map actions, java.util.Map windowProperties, Properties responseProperties, java.lang.String headerChars, WindowState windowState, Mode mode)
          Create a new WindowResult with the information about the renderered portlet.

Method Summary

java.lang.String getContent()


java.lang.String getHeaderContent()


Mode getMode()


Properties getResponseProperties()


java.lang.String getTitle()


java.util.Collection getTriggerableActions(java.lang.String familyName)


WindowContext getWindowContext()


java.util.Map getWindowProperties()


WindowResult getWindowResult(java.lang.String windowHandle)
          Get the WindowResult for a specific portlet window.

WindowState getWindowState()


Methods inherited from class org.jboss.portal.theme.render.MarkupResult

getLayoutState, getLayoutURI, getPageName, getPageProperties, getPortalProperties, getTheme, getThemeResult, getWindowContext, getWindowContextMap, getWindowIDs, getWindowResultMap, setTheme, setThemeResult

Methods inherited from class java.lang.Object

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

Field Detail

title

private java.lang.String title

content

private java.lang.String content

actions

private java.util.Map actions

properties

private final Properties properties

headerContent

private final java.lang.String headerContent

windowProperties

private final java.util.Map windowProperties

windowState

private final WindowState windowState

mode

private final Mode mode

MODES_KEY

public static final java.lang.String MODES_KEY

See Also:: Constant Field Values

WINDOWSTATES_KEY

public static final java.lang.String WINDOWSTATES_KEY

See Also:: Constant Field Values

Constructor Detail

WindowResult

public WindowResult(java.lang.String title,
                    java.lang.String content,
                    java.util.Map actions,
                    java.util.Map windowProperties,
                    Properties responseProperties,
                    java.lang.String headerChars,
                    WindowState windowState,
                    Mode mode)

Create a new WindowResult with the information about the renderered portlet.

A window result contains the the rendered markup fragment of the portlet, the title, a map of action urls to trigger mode and state changes, and the properties that were set as portlet response properties.

Parameters:

title - the title to be displayed for this portlet in the rendered page

content - the rendered markup fragment of the portlet

actions - a map of actions possible for this portlet

windowProperties - the properties for this window

responseProperties - the properties that were set as response properties during the portlet's render or action

headerChars - content that needs to be injected into the header

See Also:

WindowResult.Action

Method Detail

getTitle

public java.lang.String getTitle()

getContent

public java.lang.String getContent()

getHeaderContent

public java.lang.String getHeaderContent()

getMode

public Mode getMode()

getWindowState

public WindowState getWindowState()

getTriggerableActions

public java.util.Collection getTriggerableActions(java.lang.String familyName)

Parameters:: familyName -
Returns:: a collection of triggerable actions for this portlet
See Also:: WindowResult.Action

getResponseProperties

public Properties getResponseProperties()

Returns:: the response properties that were set by the portlet during the render or action

getWindowProperties

public java.util.Map getWindowProperties()

Returns:: the properties that were set for this particular window

getWindowContext

public WindowContext getWindowContext()

getWindowResult

public WindowResult getWindowResult(java.lang.String windowHandle)

Description copied from class: MarkupResult

Get the WindowResult for a specific portlet window.

Overrides:: getWindowResult in class MarkupResult

Parameters:: windowHandle - the window id identifying the portlet window to get the window result for
Returns:: the window result for the provided window id