MarkupBehavior - 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.test.wsrp.framework
Class MarkupBehavior

java.lang.Object
  org.jboss.portal.test.wsrp.framework.TestProducerBehavior
      org.jboss.portal.test.wsrp.framework.MarkupBehavior

Direct Known Subclasses:: BasicMarkupBehavior, EmptyMarkupBehavior, NullMarkupBehavior, SessionMarkupBehavior

public abstract class MarkupBehavior
extends TestProducerBehavior

Behavior delivering Markup services.

Since:: 2.6
Version:: $Revision$
Author:: Chris Laprun

Field Summary

protected java.lang.String portletHandle


Fields inherited from class org.jboss.portal.test.wsrp.framework.TestProducerBehavior

callCount

Constructor Summary

MarkupBehavior()


Method Summary

abstract java.lang.String getMarkupString(Mode mode, WindowState windowState, java.lang.String navigationalState, GetMarkup getMarkup)
          Returns a markup String based on the passed information.

java.lang.String getPortletHandle()
          The portlet handle associated with this behavior for the behaviors that react to a specific portlet handle.

void modifyResponseIfNeeded(MarkupResponse markupResponse)
          Allows this behavior to modify the response after the markup has been generated.

BlockingInteractionResponse performBlockingInteraction(PerformBlockingInteraction performBlockingInteraction)
          Performs a blocking interaction and returns the appropriate response.

Methods inherited from class org.jboss.portal.test.wsrp.framework.TestProducerBehavior

incrementCallCount

Methods inherited from class java.lang.Object

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

Field Detail

portletHandle

protected java.lang.String portletHandle

Constructor Detail

MarkupBehavior

public MarkupBehavior()

Method Detail

getPortletHandle

public java.lang.String getPortletHandle()

The portlet handle associated with this behavior for the behaviors that react to a specific portlet handle. Used essentially for markup/interaction requests.

Returns:

getMarkupString

public abstract java.lang.String getMarkupString(Mode mode,
                                                 WindowState windowState,
                                                 java.lang.String navigationalState,
                                                 GetMarkup getMarkup)

Returns a markup String based on the passed information.

Parameters:: mode - the requested mode; windowState - the requested window state; navigationalState - the current navigational state; getMarkup - the original GetMarkup request (in case more information is required by this behavior)
Returns:: a possibly null markup String

performBlockingInteraction

public BlockingInteractionResponse performBlockingInteraction(PerformBlockingInteraction performBlockingInteraction)

Performs a blocking interaction and returns the appropriate response. Default implementation returns null.

Parameters:: performBlockingInteraction - the original interaction request
Returns:: a BlockingInteractionResponse

modifyResponseIfNeeded

public void modifyResponseIfNeeded(MarkupResponse markupResponse)

Allows this behavior to modify the response after the markup has been generated. The default implementation does nothing.

Parameters:: markupResponse - the response that will be passed on to the consumer