planetj.html
Class HTMLOperationGenerator

java.lang.Object
  |
  +--planetj.html.HTMLOperationGenerator

public class HTMLOperationGenerator

extends Object

Class that can be used to auto-generate HTML in order to execute Operations.

Author:

PlanetJ Corporation

Field Summary

static String	className Class name
static String	NAV_BODY_CENTER_OFF
static String	NAV_BODY_CENTER_ON
static String	NAV_BODY_LEFT_OFF
static String	NAV_BODY_LEFT_ON
static String	NAV_BODY_OFF
static String	NAV_BODY_ON
static String	NAV_BODY_RIGHT_OFF
static String	NAV_BODY_RIGHT_ON
static String	NAV_FOOTER_CENTER_OFF
static String	NAV_FOOTER_CENTER_ON
static String	NAV_FOOTER_LEFT_OFF
static String	NAV_FOOTER_LEFT_ON
static String	NAV_FOOTER_OFF
static String	NAV_FOOTER_ON
static String	NAV_FOOTER_RIGHT_OFF
static String	NAV_FOOTER_RIGHT_ON
static String	NAV_HEADER_CENTER_OFF
static String	NAV_HEADER_CENTER_ON
static String	NAV_HEADER_LEFT_OFF
static String	NAV_HEADER_LEFT_ON
static String	NAV_HEADER_OFF
static String	NAV_HEADER_ON
static String	NAV_HEADER_RIGHT_OFF
static String	NAV_HEADER_RIGHT_ON
static String	NAV_SET_OFF
static String	NAV_SET_ON
static String	OPERATION_SET_HEADER
static String	TOC_BUTTON_OFF_LEFT
static String	TOC_BUTTON_OFF_MIDDLE
static String	TOC_BUTTON_OFF_RIGHT
static String	TOC_BUTTON_ON_LEFT
static String	TOC_BUTTON_ON_MIDDLE
static String	TOC_BUTTON_ON_RIGHT

Method Summary

StringBuffer	appendOperationInstructions(Operation operation, StringBuffer html) Appends the givin operation's instructions.
StringBuffer	appendOperationInstructions(String instructions, StringBuffer html) Appends the givin operation's instructions.
StringBuffer	appendOperationLink(Operation operation, String styleClass, StringBuffer html, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Appends a html link to run the given Operation.
StringBuffer	appendTOCLinks(Application app, StringBuffer html, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Appends a HTML table containing all the displayable Operations for the given Application.
boolean	containsGeneratableOperationLinks(Application application, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
String	generateOperation(Operation operation, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Deprecated. (6/27/2003 1:04:59 PM) - this method has been here since Jan 28, 2003 and hasn't changed.
String	generateOperationLinks(Application application, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Generates links for the Application's Operations.
String	generateOperationLinks(List operations, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Generates links for the given Operations.
String	generateOperationSets(Application application, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Generates links for the Application's Operations.
void	includeChildOperations(Operation operation, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Includes the Operation's JSP file.
void	includeOperation(Operation operation, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Includes the Operation's JSP file.
void	includeOperation(Row row, Operation operation, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Includes the Operation's JSP file.
static HTMLOperationGenerator	singleton() Gets the singleton instance.

Methods inherited from class java.lang.Object

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

Field Detail

className

public static final String className

Class name

OPERATION_SET_HEADER

public static final String OPERATION_SET_HEADER

See Also:

Constant Field Values

TOC_BUTTON_OFF_LEFT

public static final String TOC_BUTTON_OFF_LEFT

See Also:

Constant Field Values

TOC_BUTTON_OFF_MIDDLE

public static final String TOC_BUTTON_OFF_MIDDLE

See Also:

Constant Field Values

TOC_BUTTON_OFF_RIGHT

public static final String TOC_BUTTON_OFF_RIGHT

See Also:

Constant Field Values

TOC_BUTTON_ON_LEFT

public static final String TOC_BUTTON_ON_LEFT

See Also:

Constant Field Values

TOC_BUTTON_ON_MIDDLE

public static final String TOC_BUTTON_ON_MIDDLE

See Also:

Constant Field Values

TOC_BUTTON_ON_RIGHT

public static final String TOC_BUTTON_ON_RIGHT

See Also:

Constant Field Values

NAV_SET_ON

public static final String NAV_SET_ON

See Also:

Constant Field Values

NAV_SET_OFF

public static final String NAV_SET_OFF

See Also:

Constant Field Values

NAV_HEADER_ON

public static final String NAV_HEADER_ON

See Also:

Constant Field Values

NAV_HEADER_OFF

public static final String NAV_HEADER_OFF

See Also:

Constant Field Values

NAV_HEADER_LEFT_ON

public static final String NAV_HEADER_LEFT_ON

See Also:

Constant Field Values

NAV_HEADER_LEFT_OFF

public static final String NAV_HEADER_LEFT_OFF

See Also:

Constant Field Values

NAV_HEADER_CENTER_ON

public static final String NAV_HEADER_CENTER_ON

See Also:

Constant Field Values

NAV_HEADER_CENTER_OFF

public static final String NAV_HEADER_CENTER_OFF

See Also:

Constant Field Values

NAV_HEADER_RIGHT_ON

public static final String NAV_HEADER_RIGHT_ON

See Also:

Constant Field Values

NAV_HEADER_RIGHT_OFF

public static final String NAV_HEADER_RIGHT_OFF

See Also:

Constant Field Values

NAV_BODY_ON

public static final String NAV_BODY_ON

See Also:

Constant Field Values

NAV_BODY_OFF

public static final String NAV_BODY_OFF

See Also:

Constant Field Values

NAV_BODY_LEFT_ON

public static final String NAV_BODY_LEFT_ON

See Also:

Constant Field Values

NAV_BODY_LEFT_OFF

public static final String NAV_BODY_LEFT_OFF

See Also:

Constant Field Values

NAV_BODY_CENTER_ON

public static final String NAV_BODY_CENTER_ON

See Also:

Constant Field Values

NAV_BODY_CENTER_OFF

public static final String NAV_BODY_CENTER_OFF

See Also:

Constant Field Values

NAV_BODY_RIGHT_ON

public static final String NAV_BODY_RIGHT_ON

See Also:

Constant Field Values

NAV_BODY_RIGHT_OFF

public static final String NAV_BODY_RIGHT_OFF

See Also:

Constant Field Values

NAV_FOOTER_ON

public static final String NAV_FOOTER_ON

See Also:

Constant Field Values

NAV_FOOTER_OFF

public static final String NAV_FOOTER_OFF

See Also:

Constant Field Values

NAV_FOOTER_LEFT_ON

public static final String NAV_FOOTER_LEFT_ON

See Also:

Constant Field Values

NAV_FOOTER_LEFT_OFF

public static final String NAV_FOOTER_LEFT_OFF

See Also:

Constant Field Values

NAV_FOOTER_CENTER_ON

public static final String NAV_FOOTER_CENTER_ON

See Also:

Constant Field Values

NAV_FOOTER_CENTER_OFF

public static final String NAV_FOOTER_CENTER_OFF

See Also:

Constant Field Values

NAV_FOOTER_RIGHT_ON

public static final String NAV_FOOTER_RIGHT_ON

See Also:

Constant Field Values

NAV_FOOTER_RIGHT_OFF

public static final String NAV_FOOTER_RIGHT_OFF

See Also:

Constant Field Values

Method Detail

appendOperationInstructions

public StringBuffer appendOperationInstructions(String instructions,
                                                StringBuffer html)
                                         throws CMException

Appends the givin operation's instructions. The instructions are generated within a table

CMException

appendOperationInstructions

public StringBuffer appendOperationInstructions(Operation operation,
                                                StringBuffer html)
                                         throws CMException

Appends the givin operation's instructions. The instructions are generated within a table

CMException

appendOperationLink

public StringBuffer appendOperationLink(Operation operation,
                                        String styleClass,
                                        StringBuffer html,
                                        javax.servlet.http.HttpServletRequest request,
                                        javax.servlet.http.HttpServletResponse response)
                                 throws CMException

Appends a html link to run the given Operation.

Parameters:

operation - Operation to generate link for

html - StringBuffer to append link to

request - HttpServletRequest from client

response - HttpServletResponse to client

Returns:

buffer Operation link was appended to

CMException

appendTOCLinks

public StringBuffer appendTOCLinks(Application app,
                                   StringBuffer html,
                                   javax.servlet.http.HttpServletRequest request,
                                   javax.servlet.http.HttpServletResponse response)
                            throws CMException

Appends a HTML table containing all the displayable Operations for the given Application.

Parameters:

html - Buffer to append generated HTML code to

request - HttpServletRequest from the client

response - HttpServletResponse to the client

Returns:

StringBuffer containing generated code

CMException

containsGeneratableOperationLinks

public boolean containsGeneratableOperationLinks(Application application,
                                                 javax.servlet.http.HttpServletRequest request,
                                                 javax.servlet.http.HttpServletResponse response)

generateOperation

public String generateOperation(Operation operation,
                                javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response)

Deprecated. (6/27/2003 1:04:59 PM) - this method has been here since Jan 28, 2003 and hasn't changed.

Generates HTML code for the given operation.

Parameters:

operation - Operation to generate HTML code for.

generateOperationLinks

public String generateOperationLinks(List operations,
                                     javax.servlet.http.HttpServletRequest request,
                                     javax.servlet.http.HttpServletResponse response)
                              throws CMException

Generates links for the given Operations.

Parameters:

operations - List of Operations to generate links for.

CMException

generateOperationLinks

public String generateOperationLinks(Application application,
                                     javax.servlet.http.HttpServletRequest request,
                                     javax.servlet.http.HttpServletResponse response)

Generates links for the Application's Operations. The links are grouped by OperationSet and displayed by their display order.

Parameters:

application - Application containing Operations to generate links for.

generateOperationSets

public String generateOperationSets(Application application,
                                    javax.servlet.http.HttpServletRequest request,
                                    javax.servlet.http.HttpServletResponse response)

Generates links for the Application's Operations. The links are grouped by OperationSet and displayed by their display order.

Parameters:

application - Application containing Operations to generate links for.

includeChildOperations

public void includeChildOperations(Operation operation,
                                   javax.servlet.http.HttpServletRequest request,
                                   javax.servlet.http.HttpServletResponse response)
                            throws CMException

Includes the Operation's JSP file.

Parameters:

operation - Operation to generate HTML code for.

CMException

includeOperation

public void includeOperation(Row row,
                             Operation operation,
                             javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response)
                      throws CMException

Includes the Operation's JSP file.

Parameters:

operation - Operation to generate HTML code for.

CMException

includeOperation

public void includeOperation(Operation operation,
                             javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response)
                      throws CMException

Includes the Operation's JSP file.

Parameters:

operation - Operation to generate HTML code for.

CMException

singleton

public static HTMLOperationGenerator singleton()

Gets the singleton instance.