org.jgrapes.portal.base.events

Class AddPortletRequest

java.lang.Object

org.jgrapes.core.internal.EventBase<T>

org.jgrapes.core.Event<T>

org.jgrapes.portal.base.events.RenderPortletRequestBase<String>

org.jgrapes.portal.base.events.AddPortletRequest

All Implemented Interfaces:

Future<String>, org.jgrapes.core.Associator, org.jgrapes.core.Eligible

public class AddPortletRequest
extends RenderPortletRequestBase<String>

Sent to the portal (server) if a new portlet instance of a given type should be added to the portal page. The portal server usually responds with a RenderPortlet event that has as payload the HTML that displays the portlet on the portal page.

Properties may be passed with the event. The interpretation of the properties is completely dependent on the handling portlet. It is recommended to use Strings as keys and JDK types as values. This avoids classpath dependencies on the portlet that is to be added.

The event’s result is the portlet id of the new portlet instance.

Field Summary

Fields inherited from class org.jgrapes.core.internal.EventBase

completed, completionEvents

Constructor Summary

Constructors

Constructor and Description
AddPortletRequest(RenderSupport renderSupport, String portletType, List<Portlet.RenderMode> renderModes) Creates a new event.
AddPortletRequest(RenderSupport renderSupport, String portletType, List<Portlet.RenderMode> renderModes, Map<?,?> properties) Creates a new event.

Method Summary

Modifier and Type	Method and Description
AddPortletRequest	addProperty(Object key, Object value) Convenience method for adding properties one-by-one.
AddPortletRequest	ifPresent(Object key, BiConsumer<Object,Object> action) Convenience method that performs the given action if a property with the given key exists.
boolean	isForeground() Indicates if portlet is to be put in foreground.
String	portletType() Returns the portlet type
Map<Object,Object>	properties() Returns the properties.
AddPortletRequest	setForeground(boolean foreground) Determines if the portlet will be put in the foreground.

Methods inherited from class org.jgrapes.portal.base.events.RenderPortletRequestBase

preferredRenderMode, renderModes, renderSupport

Methods inherited from class org.jgrapes.core.Event

addCompletionEvent, associated, cancel, channels, channels, completionEvents, currentResults, defaultCriterion, forChannels, get, get, handled, handlingError, isCancelled, isDone, isEligibleFor, isStopped, processedBy, results, results, setAssociated, setChannels, setRequiresResult, setResult, stop, tieTo, toString

Methods inherited from class org.jgrapes.core.internal.EventBase

disableTracking, enqueued, firstResultAssigned, isTracked

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jgrapes.core.Associator

associated, associated, associated

Constructor Detail

AddPortletRequest

public AddPortletRequest(RenderSupport renderSupport,
                         String portletType,
                         List<Portlet.RenderMode> renderModes)

Creates a new event.

Parameters:

renderSupport - the render support

portletType - the type of the portlet

renderModes - the render modes

AddPortletRequest

public AddPortletRequest(RenderSupport renderSupport,
                         String portletType,
                         List<Portlet.RenderMode> renderModes,
                         Map<?,?> properties)

Creates a new event.

Parameters:

renderSupport - the render support

portletType - the type of the portlet

renderModes - the render modes

properties - optional values for properties of the portlet instance

Method Detail

setForeground

public AddPortletRequest setForeground(boolean foreground)

Determines if the portlet will be put in the foreground. Defaults to true for added portlets as they are most likely supposed to be seen.

Parameters:

foreground - the foreground

Returns:

the event for easy chaining

portletType

public String portletType()

Returns the portlet type

Returns:

the portlet type

properties

public Map<Object,Object> properties()

Returns the properties. Every event returns a mutable map, thus allowing event handlers to modify the map even if none was passed to the constructor.

addProperty

public AddPortletRequest addProperty(Object key,
                                     Object value)

Convenience method for adding properties one-by-one.

Parameters:

key - the property key

value - the property value

Returns:

the event for easy chaining

ifPresent

public AddPortletRequest ifPresent(Object key,
                                   BiConsumer<Object,Object> action)

Convenience method that performs the given action if a property with the given key exists.

Parameters:

key - the property key

action - the action to perform

isForeground

public boolean isForeground()

Description copied from class: RenderPortletRequestBase

Indicates if portlet is to be put in foreground.

Specified by:

isForeground in class RenderPortletRequestBase<String>

Returns:

the result