|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DNDMarkupGenerator
Implementations of DNDMarkupGenerator produce the markup required for
DnD operations.
The order in which methods in the class are called is important. First,
it is important that doLibraryIncludeMarkup is called at least once per request.
Developer's should always call this method immediately after retrieving the
DNDMarkupGenerator and include the markup returned by this method. In addition,
the markup generated by methods in this class should be included in an application's
markup in a "well formed" manner. For example, it is valid to include the results of
the following method calls in this order:
1. doBeginDNDSource
2. doBeginDNDTarget
3. doEndDNDTarget
4. doEndDNDSource
But, it is not valid to include the results of the following method calls in this order:
1. doBeginDNDSource
2. doBeginDNDTarget
3. doEndDNDSource
4. doEndDNDTarget
Method Summary | |
---|---|
void |
doBeginDNDSource(DNDSource src,
javax.portlet.PortletRequest req,
javax.portlet.PortletResponse res,
java.io.Writer out,
boolean includeDragHandle)
Generates markup that needs to be placed at the beginning of a DNDSource. |
void |
doBeginDNDSource(DNDSource src,
javax.servlet.ServletRequest req,
javax.servlet.ServletResponse res,
java.io.Writer out,
boolean includeDragHandle)
Generates markup that needs to be placed at the beginning of a DNDSource. |
void |
doBeginDNDSourceHandle(DNDSource src,
javax.portlet.PortletRequest req,
javax.portlet.PortletResponse res,
java.io.Writer out)
Generates markup that needs to be placed at the beginning of a DNDSource handle. |
void |
doBeginDNDSourceHandle(DNDSource src,
javax.servlet.ServletRequest req,
javax.servlet.ServletResponse res,
java.io.Writer out)
Generates markup that needs to be placed at the beginning of a DNDSource handle. |
void |
doBeginDNDTarget(DNDTarget tgt,
javax.portlet.PortletRequest req,
javax.portlet.PortletResponse res,
java.io.Writer out)
Generates markup that needs to be placed at the beginning of a DNDTarget. |
void |
doBeginDNDTarget(DNDTarget tgt,
javax.servlet.ServletRequest req,
javax.servlet.ServletResponse res,
java.io.Writer out)
Generates markup that needs to be placed at the beginning of a DNDTarget. |
void |
doEndDNDSource(DNDSource src,
javax.portlet.PortletRequest req,
javax.portlet.PortletResponse res,
java.io.Writer out)
Generates markup that needs to be placed at the end of a DNDSource. |
void |
doEndDNDSource(DNDSource src,
javax.servlet.ServletRequest req,
javax.servlet.ServletResponse res,
java.io.Writer out)
Generates markup that needs to be placed at the end of a DNDSource. |
void |
doEndDNDSourceHandle(DNDSource src,
javax.portlet.PortletRequest req,
javax.portlet.PortletResponse res,
java.io.Writer out)
Generates markup that needs to be placed at the end of a DNDSource handle. |
void |
doEndDNDSourceHandle(DNDSource src,
javax.servlet.ServletRequest req,
javax.servlet.ServletResponse res,
java.io.Writer out)
Generates markup that needs to be placed at the end of a DNDSource handle. |
void |
doEndDNDTarget(DNDTarget tgt,
javax.portlet.PortletRequest req,
javax.portlet.PortletResponse res,
java.io.Writer out)
Generates markup that needs to be placed at the end of a DNDTarget. |
void |
doEndDNDTarget(DNDTarget tgt,
javax.servlet.ServletRequest req,
javax.servlet.ServletResponse res,
java.io.Writer out)
Generates markup that needs to be placed at the end of a DNDTarget. |
void |
doLibraryIncludeMarkup(javax.portlet.PortletRequest req,
javax.portlet.PortletResponse res,
java.io.Writer out)
This method generates the markup that includes required DnD javascript libraries in a response. |
void |
doLibraryIncludeMarkup(javax.servlet.ServletRequest req,
javax.servlet.ServletResponse res,
java.io.Writer out)
This method generates the markup that includes required DnD javascript libraries in a response. |
Method Detail |
---|
void doLibraryIncludeMarkup(javax.servlet.ServletRequest req, javax.servlet.ServletResponse res, java.io.Writer out)
req
- the servlet requestres
- the servlet responseout
- the java.io.Writer to write output tovoid doLibraryIncludeMarkup(javax.portlet.PortletRequest req, javax.portlet.PortletResponse res, java.io.Writer out)
req
- the portlet requestres
- the portlet responseout
- the java.io.Writer to write output tovoid doBeginDNDSource(DNDSource src, javax.servlet.ServletRequest req, javax.servlet.ServletResponse res, java.io.Writer out, boolean includeDragHandle) throws DNDMarkupGeneratorException
src
- the DNDSource markup is being generated forreq
- the servlet requestres
- the servlet responseout
- the java.io.Writer to write output toincludeDragHandle
- true if we should generate a handle from this method
DNDMarkupGeneratorException
- This exception will be thrown if, for some reason, the markup cannot be generated.void doBeginDNDSource(DNDSource src, javax.portlet.PortletRequest req, javax.portlet.PortletResponse res, java.io.Writer out, boolean includeDragHandle) throws DNDMarkupGeneratorException
src
- the DNDSource markup is being generated forreq
- the portlet requestres
- the portlet responseout
- the java.io.Writer to write output toincludeDragHandle
- true if we should generate a handle from this method
DNDMarkupGeneratorException
- This exception will be thrown if, for some reason, the markup cannot be generated.void doBeginDNDSourceHandle(DNDSource src, javax.servlet.ServletRequest req, javax.servlet.ServletResponse res, java.io.Writer out) throws DNDMarkupGeneratorException
src
- the DNDSource that handle markup is being generated forreq
- the servlet requestres
- the servlet responseout
- the java.io.Writer to write output to
DNDMarkupGeneratorException
- This exception will be thrown if, for some reason, the markup cannot be generated.void doBeginDNDSourceHandle(DNDSource src, javax.portlet.PortletRequest req, javax.portlet.PortletResponse res, java.io.Writer out) throws DNDMarkupGeneratorException
src
- the DNDSource that handle markup is being generated forreq
- the portlet requestres
- the portlet responseout
- the java.io.Writer to write output to
DNDMarkupGeneratorException
- This exception will be thrown if, for some reason, the markup cannot be generated.void doBeginDNDTarget(DNDTarget tgt, javax.servlet.ServletRequest req, javax.servlet.ServletResponse res, java.io.Writer out) throws DNDMarkupGeneratorException
tgt
- the DNDTarget markup is being generated forreq
- the servlet requestres
- the servlet responseout
- the java.io.Writer to write output to
DNDMarkupGeneratorException
- This exception will be thrown if, for some reason, the markup cannot be generated.void doBeginDNDTarget(DNDTarget tgt, javax.portlet.PortletRequest req, javax.portlet.PortletResponse res, java.io.Writer out) throws DNDMarkupGeneratorException
tgt
- the DNDTarget markup is being generated forreq
- the portlet requestres
- the portlet responseout
- the java.io.Writer to write output to
DNDMarkupGeneratorException
- This exception will be thrown if, for some reason, the markup cannot be generated.void doEndDNDSource(DNDSource src, javax.servlet.ServletRequest req, javax.servlet.ServletResponse res, java.io.Writer out) throws DNDMarkupGeneratorException
src
- the DNDSource markup is being generated forreq
- the servlet requestres
- the servlet responseout
- the java.io.Writer to write output to
DNDMarkupGeneratorException
- This exception will be thrown if, for some reason, the markup cannot be generated.void doEndDNDSource(DNDSource src, javax.portlet.PortletRequest req, javax.portlet.PortletResponse res, java.io.Writer out) throws DNDMarkupGeneratorException
src
- the DNDSource markup is being generated forreq
- the portlet requestres
- the portlet responseout
- the java.io.Writer to write output to
DNDMarkupGeneratorException
- This exception will be thrown if, for some reason, the markup cannot be generated.void doEndDNDSourceHandle(DNDSource src, javax.servlet.ServletRequest req, javax.servlet.ServletResponse res, java.io.Writer out) throws DNDMarkupGeneratorException
src
- the DNDSource that handle markup is being generated forreq
- the servlet requestres
- the servlet responseout
- the java.io.Writer to write output to
DNDMarkupGeneratorException
- This exception will be thrown if, for some reason, the markup cannot be generated.void doEndDNDSourceHandle(DNDSource src, javax.portlet.PortletRequest req, javax.portlet.PortletResponse res, java.io.Writer out) throws DNDMarkupGeneratorException
src
- the DNDSource that handle markup is being generated forreq
- the portlet requestres
- the portlet responseout
- the java.io.Writer to write output to
DNDMarkupGeneratorException
- This exception will be thrown if, for some reason, the markup cannot be generated.void doEndDNDTarget(DNDTarget tgt, javax.servlet.ServletRequest req, javax.servlet.ServletResponse res, java.io.Writer out) throws DNDMarkupGeneratorException
tgt
- the DNDTarget markup is being generated forreq
- the servlet requestres
- the servlet responseout
- the java.io.Writer to write output to
DNDMarkupGeneratorException
- This exception will be thrown if, for some reason, the markup cannot be generated.void doEndDNDTarget(DNDTarget tgt, javax.portlet.PortletRequest req, javax.portlet.PortletResponse res, java.io.Writer out) throws DNDMarkupGeneratorException
tgt
- the DNDTarget markup is being generated forreq
- the portlet requestres
- the portlet responseout
- the java.io.Writer to write output to
DNDMarkupGeneratorException
- This exception will be thrown if, for some reason, the markup cannot be generated.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |