org.apache.wicket.settings
Interface IDebugSettings

All Known Implementing Classes:
Settings

public interface IDebugSettings

Settings interface for various debug settings

componentUseCheck (defaults to true in development mode) - causes the framework to do a check after rendering each page to ensure that each component was used in rendering the markup. If components are found that are not referenced in the markup, an appropriate error will be displayed serializeSessionAttributes (defaults to true in development mode) - Causes the framework to serialize any attribute put into session - this helps find Not Serializable errors early

Author:
Igor Vaynberg (ivaynberg)

Method Summary
 boolean getComponentUseCheck()
           
 boolean isAjaxDebugModeEnabled()
          Returns status of ajax debug mode.
 boolean isDevelopmentUtilitiesEnabled()
          Are all of the panels and pages, etc, from wicket-devutils package enabled?
 boolean isLinePreciseReportingOnAddComponentEnabled()
          Returns status of line precise error reporting for added components that are not present in the markup: it points to the line where the component was added to the hierarchy in your Java classes.
 boolean isLinePreciseReportingOnNewComponentEnabled()
          Returns status of line precise error reporting for new components that are not present in the markup: it points to the line where the component was created in your Java classes.
 boolean isOutputComponentPath()
           
 boolean isOutputMarkupContainerClassName()
          Returns whether the output of markup container's should be wrapped by comments containing the container's class name.
 void setAjaxDebugModeEnabled(boolean enable)
          Enables or disables ajax debug mode.
 void setComponentUseCheck(boolean check)
          Sets componentUseCheck debug settings
 void setDevelopmentUtilitiesEnabled(boolean enable)
          Enables all of the panels and pages, etc, from wicket-devutils package.
 void setLinePreciseReportingOnAddComponentEnabled(boolean enable)
          Enables line precise error reporting for added components that are not present in the markup: it points to the line where the component was added to the hierarchy in your Java classes.
 void setLinePreciseReportingOnNewComponentEnabled(boolean enable)
          Enables line precise error reporting for new components that are not present in the markup: it points to the line where the component was created in your Java classes.
 void setOutputComponentPath(boolean enabled)
          If set to true wicket will output component path in a wicketpath attribute of the component tag.
 void setOutputMarkupContainerClassName(boolean enable)
          Enables wrapping output of markup container in html comments that contain markup container's class name.
 

Method Detail

setOutputComponentPath

void setOutputComponentPath(boolean enabled)
If set to true wicket will output component path in a wicketpath attribute of the component tag. This can be useful for debugging and automating tests.

Parameters:
enabled -

isOutputComponentPath

boolean isOutputComponentPath()
Returns:
true if output component path feature is enabled, false otherwise
See Also:
setOutputComponentPath(boolean)

getComponentUseCheck

boolean getComponentUseCheck()
Returns:
true if componentUseCheck is enabled

setComponentUseCheck

void setComponentUseCheck(boolean check)
Sets componentUseCheck debug settings

Parameters:
check -

setAjaxDebugModeEnabled

void setAjaxDebugModeEnabled(boolean enable)
Enables or disables ajax debug mode. See IDebugSettings for details

Parameters:
enable -

isAjaxDebugModeEnabled

boolean isAjaxDebugModeEnabled()
Returns status of ajax debug mode. See IDebugSettings for details

Returns:
true if ajax debug mode is enabled, false otherwise

setOutputMarkupContainerClassName

void setOutputMarkupContainerClassName(boolean enable)
Enables wrapping output of markup container in html comments that contain markup container's class name. (Useful for determining which part of page belongs to which markup file).

Parameters:
enable -

isOutputMarkupContainerClassName

boolean isOutputMarkupContainerClassName()
Returns whether the output of markup container's should be wrapped by comments containing the container's class name.

Returns:
true if the markup container's class name should be written to response

isLinePreciseReportingOnAddComponentEnabled

boolean isLinePreciseReportingOnAddComponentEnabled()
Returns status of line precise error reporting for added components that are not present in the markup: it points to the line where the component was added to the hierarchy in your Java classes. This can cause a significant decrease in performance, do not use in customer facing applications.

Returns:
true if the line precise error reporting is enabled

setLinePreciseReportingOnAddComponentEnabled

void setLinePreciseReportingOnAddComponentEnabled(boolean enable)
Enables line precise error reporting for added components that are not present in the markup: it points to the line where the component was added to the hierarchy in your Java classes. This can cause a significant decrease in performance, do not use in customer facing applications.

Parameters:
enable -

isLinePreciseReportingOnNewComponentEnabled

boolean isLinePreciseReportingOnNewComponentEnabled()
Returns status of line precise error reporting for new components that are not present in the markup: it points to the line where the component was created in your Java classes. This can cause a significant decrease in performance, do not use in customer facing applications.

Returns:
true if the line precise error reporting is enabled

setLinePreciseReportingOnNewComponentEnabled

void setLinePreciseReportingOnNewComponentEnabled(boolean enable)
Enables line precise error reporting for new components that are not present in the markup: it points to the line where the component was created in your Java classes. This can cause a significant decrease in performance, do not use in customer facing applications.

Parameters:
enable -

setDevelopmentUtilitiesEnabled

void setDevelopmentUtilitiesEnabled(boolean enable)
Enables all of the panels and pages, etc, from wicket-devutils package.

Parameters:
enable -

isDevelopmentUtilitiesEnabled

boolean isDevelopmentUtilitiesEnabled()
Are all of the panels and pages, etc, from wicket-devutils package enabled?

Returns:
true if all of the panels and pages, etc, from wicket-devutils package are enabled


Copyright © 2004-2011 Apache Software Foundation. All Rights Reserved.