com.github.bordertech.wcomponents.lde

Class DevToolkit

java.lang.Object

com.github.bordertech.wcomponents.lde.DevToolkit

public final class DevToolkit
extends Object

This component adds a "Developer Toolkit" to the UI.

This class is WComponent-like, but doesn't use any of the WComponent classes as we don't want it to get in the way when debugging in the LDE.

NOTE: The dev toolkit affects the entire VM, so no effort has been made to make it function correctly when there are multiple users accessing the LDE.

.

Since:

1.0.0

Author:

Yiannis Paschalidis

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DevToolkit.UITreeNode Simple node extension for displaying the UI structure.

Constructor Summary

Constructors

Constructor and Description
DevToolkit()

Method Summary

Methods

Modifier and Type	Method and Description
String	encode(String input) XML-encodes the given input.
String[][]	getConfig()
String[][]	getRequestHeaders() Retrieves the headers for the last request.
String	getRequestMethod() Retrieves the HTTP method for the last request.
String[][]	getRequestParameters() Retrieves the parameters for the last request.
String	getRootComponent()
TreeNode	getTree() Retrieves a tree representation of the WComponent UI being served by the LDE, in a format suitable for rendering to the UI.
String	getUicStats() Retrieves statistics on the active UIContext, in a format suitable for rendering to the UI.
boolean	isDebugEnabled()
static boolean	isEnabled() Determines whether the toolkit is enabled, based on the application Parameters.
boolean	isShowConfig()
boolean	isShowIds()
boolean	isShowRequest()
boolean	isShowTree()
boolean	isShowUicStats()
boolean	isWhitespaceFilterEnabled()
void	paintFooter(PrintWriter writer) Renders the DevToolkit content which must after before the main WComponent UI.
void	paintHeader(PrintWriter writer) Renders the DevToolkit content which must appear before the main WComponent UI.
protected void	serviceRequest(javax.servlet.http.HttpServletRequest request) Reads the state of the dev toolkit user interface.

Methods inherited from class java.lang.Object

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

Constructor Detail

DevToolkit

public DevToolkit()

Method Detail

isEnabled

public static boolean isEnabled()

Determines whether the toolkit is enabled, based on the application Parameters.

Returns:

true if the toolkit is enabled, false otherwise.

serviceRequest

protected void serviceRequest(javax.servlet.http.HttpServletRequest request)

Reads the state of the dev toolkit user interface.

The toolkit UI is implemented in a separate form with a hidden field to identify it, so any request to the main WComponent application being run in the LDE should skip this processing.

Parameters:

request - the current request being responded to

getRequestHeaders

public String[][] getRequestHeaders()

Retrieves the headers for the last request. The headers are returned as an array of key-value pairs.

Returns:

the headers for the current request.

getRequestMethod

public String getRequestMethod()

Retrieves the HTTP method for the last request.

Returns:

the HTTP method - "GET", "POST" or "PUT".

getRequestParameters

public String[][] getRequestParameters()

Retrieves the parameters for the last request. The parameters are returned as an array of key-value pairs. Note that this will not return any results for multi-part encoded form data.

Returns:

the parameters for the current request.

getTree

public TreeNode getTree()

Retrieves a tree representation of the WComponent UI being served by the LDE, in a format suitable for rendering to the UI.

Returns:

a tree representation of the WComponent UI.

getUicStats

public String getUicStats()

Retrieves statistics on the active UIContext, in a format suitable for rendering to the UI.

Returns:

statistics on the active UIContext.

isShowTree

public boolean isShowTree()

Returns:

true if the WComponent UI hierarchy tree view should be displayed, false otherwise.

isShowConfig

public boolean isShowConfig()

Returns:

true if the current WComponent Configuration should be displayed, false otherwise.

isShowUicStats

public boolean isShowUicStats()

Returns:

true if statistics on the active UIContext should be displayed, false otherwise.

isShowRequest

public boolean isShowRequest()

Returns:

true if information about the current HTTP request should be displayed, false otherwise.

isWhitespaceFilterEnabled

public boolean isWhitespaceFilterEnabled()

Returns:

true if the WComponent whitespace filter is enabled.

isShowIds

public boolean isShowIds()

Returns:

true if component ids should be displayed, false otherwise.

getRootComponent

public String getRootComponent()

Returns:

the fully qualified class name for the component being served by the LDE.

isDebugEnabled

public boolean isDebugEnabled()

Returns:

true if the client-side WComponent debugging features are enabled.

getConfig

public String[][] getConfig()

Returns:

the current configuration information as an array of key-value pairs, sorted by key.

encode

public String encode(String input)

XML-encodes the given input. This is called by the velocity template.

Parameters:

input - the input to encode.

Returns:

the encoded input.

paintHeader

public void paintHeader(PrintWriter writer)

Renders the DevToolkit content which must appear before the main WComponent UI.

Parameters:

writer - the writer to send the content to.

paintFooter

public void paintFooter(PrintWriter writer)

Renders the DevToolkit content which must after before the main WComponent UI.

Parameters:

writer - the writer to send the content to.