|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DNDFactory
Implementations of DNDFactory will be able to create DNDSource, DNDTarget, and DNDProperty objects. NOTE: This API may only be used in the scope of an HTTP request in WebSphere Portal, i.e. within a theme. The API can not be invoked directly by a custom servlet.
Method Summary | |
---|---|
DNDAction |
createAction(java.lang.String action,
DNDProperty[] properties,
DNDValidator validator,
java.lang.String optionalActionHandlerMarkup,
java.lang.String activeCssClassName,
java.lang.String awareCssClassName,
boolean supportsMultiselect,
java.lang.String multiselectDelimiter)
This method is used to create a DNDAction object with the parameters provided. |
DNDProperty |
createProperty(java.lang.String namespace,
java.lang.String type,
java.lang.String name,
java.lang.Object value)
This method is used to create a DNDProperty object with the parameters provided. |
DNDSource |
createSource(javax.servlet.http.HttpServletRequest request,
DNDProperty[] properties,
DNDValidator validator,
java.lang.String optionalOnDragHandlerMarkup,
boolean dragClone,
boolean isMultiselectable,
java.lang.String cssClassName)
This method is used to create a DNDSource object with the paramters provided. |
DNDSource |
createSource(javax.portlet.PortletRequest request,
DNDProperty[] properties,
DNDValidator validator,
java.lang.String optionalOnDragHandlerMarkup,
boolean dragClone,
boolean isMultiselectable,
java.lang.String cssClassName)
This method is used to create a DNDSource object with the paramters provided. |
DNDTarget |
createTarget(javax.servlet.http.HttpServletRequest request,
DNDAction[] actions)
This method is used to create a DNDTarget object with the provided paramters. |
DNDTarget |
createTarget(javax.portlet.PortletRequest request,
DNDAction[] actions)
This method is used to create a DNDTarget object with the provided paramters. |
Method Detail |
---|
DNDProperty createProperty(java.lang.String namespace, java.lang.String type, java.lang.String name, java.lang.Object value) throws DNDInvalidParametersException
namespace
- (not null) the namespace of this DNDProperty used for matching DNDSource objects to DNDTarget objectstype
- (not null) the type of this DNDProperty used for matching DNDSource objects to DNDTarget objectsname
- (may be null) the name that will be used for this DNDProperty in the request when a DND interaction takes placevalue
- (may be null) the value that should be provided for this DNDProperty when a DND interaction occurs
DNDInvalidParametersException
- when the object cannot be createdDNDSource createSource(javax.servlet.http.HttpServletRequest request, DNDProperty[] properties, DNDValidator validator, java.lang.String optionalOnDragHandlerMarkup, boolean dragClone, boolean isMultiselectable, java.lang.String cssClassName) throws DNDInvalidParametersException
request
- (not null) the current ServletRequestproperties
- (not null) the set of DNDProperties with this DNDSourcevalidator
- (may be null) the optional DNDValidator needed for this DNDSourceoptionalOnDragHandlerMarkup
- (may be null) the optional JavaScript markup to be invoked during a dragdragClone
- true to drag a clone of this markup, false otherwiseisMultiselectable
- true if users should be allowed to multiselect this DNDSource with DNDSource objects that have matching typescssClassName
- (may be null) the CSS class for this DNDSource during a drag, if null a default is used
DNDInvalidParametersException
- if the object cannot be createdDNDSource createSource(javax.portlet.PortletRequest request, DNDProperty[] properties, DNDValidator validator, java.lang.String optionalOnDragHandlerMarkup, boolean dragClone, boolean isMultiselectable, java.lang.String cssClassName) throws DNDInvalidParametersException
request
- (not null) the current PortletRequestproperties
- (not null) the set of DNDProperties with this DNDSourcevalidator
- (may be null) the optional DNDValidator needed for this DNDSourceoptionalOnDragHandlerMarkup
- (may be null) the optional JavaScript markup to be invoked during a dragdragClone
- true to drag a clone of this markup, false otherwiseisMultiselectable
- true if users should be allowed to multiselect this DNDSource with DNDSource objects that have matching typescssClassName
- (may be null) the CSS class for this DNDSource during a drag, if null a default is used
DNDInvalidParametersException
- if the object cannot be createdDNDTarget createTarget(javax.servlet.http.HttpServletRequest request, DNDAction[] actions) throws DNDInvalidParametersException
request
- (not null) the current ServletRequestactions
- (not null) the DNDActions associated with this DNDTarget
DNDInvalidParametersException
- if the object cannot be createdDNDTarget createTarget(javax.portlet.PortletRequest request, DNDAction[] actions) throws DNDInvalidParametersException
request
- (not null) the current PortletRequestactions
- (not null) the DNDActions associated with this DNDTarget
DNDInvalidParametersException
- if the object cannot be createdDNDAction createAction(java.lang.String action, DNDProperty[] properties, DNDValidator validator, java.lang.String optionalActionHandlerMarkup, java.lang.String activeCssClassName, java.lang.String awareCssClassName, boolean supportsMultiselect, java.lang.String multiselectDelimiter) throws DNDInvalidParametersException
action
- (not null) a URL that this DNDAction will be submitted toproperties
- (not null) the DNDProperty objects associated with this actionoptionalActionHandlerMarkup
- (may be null) the optional javascript to be executed when this DNDAction is invokedactiveCssClassName
- (may be null) the CSS class when this DNDAction's DNDTarget is "active", if null a default is usedawareCssClassName
- (may be null) the CSS class when this DNDAction's DNDTarget is "aware", if null a default is usedsupportsMultiselect
- true if multiselected DNDSource objects may be dropped on this DNDAction, false otherwisemultiselectDelimiter
- (may be null) if supportsMultiselect is true, this value is used to delimit DNDProperty values in the request
DNDInvalidParametersException
- if the object cannot be created
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |