Package com.helger.pdflayout.debug

Class PLDebugRender

java.lang.Object

com.helger.pdflayout.debug.PLDebugRender

@NotThreadSafe
public final class PLDebugRender
extends Object

This class defines stuff for debug rendering.

Since:

4.0.0-b3

Author:

Philip Helger

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PLDebugRender.IDebugBorderProvider	Provide the debug borders for elements.
static interface	PLDebugRender.IDebugColorProvider	Provide the debug color for elements.

Field Summary

Fields

Modifier and Type	Field	Description
static BorderStyleSpec	DEFAULT_BORDER_BLOCK_ELEMENT	green
static BorderStyleSpec	DEFAULT_BORDER_INLINE_ELEMENT	blue
static BorderStyleSpec	DEFAULT_BORDER_PAGESET	red
static Color	DEFAULT_COLOR_OUTLINE_BLOCK_ELEMENT
static Color	DEFAULT_COLOR_OUTLINE_INLINE_ELEMENT
static Color	DEFAULT_COLOR_OUTLINE_PAGESET
static boolean	DEFAULT_DEBUG_RENDER

Method Summary

Modifier and Type	Method	Description
static BorderStyleSpec	getDebugBorder(Object aObject)
static Color	getDebugOutlineColor(Object aObject)
static boolean	isDebugRender()
static void	resetToDefault()	Reset all debug rendering stuff to defaults.
static void	setDebugBorderProvider(PLDebugRender.IDebugBorderProvider aDebugBorderProvider)
static void	setDebugOutlineColorProvider(PLDebugRender.IDebugColorProvider aDebugOutlineColorProvider)
static void	setDebugRender(boolean bDebugRender)	Enable or disable debug rendering globally.
static <EXTYPE extends Throwable> void	withDebugRender(boolean bDebug, com.helger.commons.callback.IThrowingRunnable<EXTYPE> aRunnable)
static <EXTYPE extends Throwable> void	withDebugRender(com.helger.commons.callback.IThrowingRunnable<EXTYPE> aRunnable)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DEBUG_RENDER

public static final boolean DEFAULT_DEBUG_RENDER

See Also:

Constant Field Values

DEFAULT_COLOR_OUTLINE_PAGESET

public static final Color DEFAULT_COLOR_OUTLINE_PAGESET

DEFAULT_COLOR_OUTLINE_BLOCK_ELEMENT

public static final Color DEFAULT_COLOR_OUTLINE_BLOCK_ELEMENT

DEFAULT_COLOR_OUTLINE_INLINE_ELEMENT

public static final Color DEFAULT_COLOR_OUTLINE_INLINE_ELEMENT

DEFAULT_BORDER_PAGESET

public static final BorderStyleSpec DEFAULT_BORDER_PAGESET

red

DEFAULT_BORDER_BLOCK_ELEMENT

public static final BorderStyleSpec DEFAULT_BORDER_BLOCK_ELEMENT

green

DEFAULT_BORDER_INLINE_ELEMENT

public static final BorderStyleSpec DEFAULT_BORDER_INLINE_ELEMENT

blue

Method Detail

resetToDefault

public static void resetToDefault()

Reset all debug rendering stuff to defaults. This includes disabling of debug rendering.

isDebugRender

public static boolean isDebugRender()

Returns:

true if debug rendering is enabled, false if not.

setDebugRender

public static void setDebugRender(boolean bDebugRender)

Enable or disable debug rendering globally.

Parameters:

bDebugRender - true to enable it, false to disable it.

setDebugOutlineColorProvider

public static void setDebugOutlineColorProvider(@Nonnull
                                                PLDebugRender.IDebugColorProvider aDebugOutlineColorProvider)

getDebugOutlineColor

@Nullable
public static Color getDebugOutlineColor(@Nonnull
                                         Object aObject)

setDebugBorderProvider

public static void setDebugBorderProvider(@Nonnull
                                          PLDebugRender.IDebugBorderProvider aDebugBorderProvider)

getDebugBorder

@Nullable
public static BorderStyleSpec getDebugBorder(@Nonnull
                                             Object aObject)

withDebugRender

public static <EXTYPE extends Throwable> void withDebugRender(@Nonnull
                                                              com.helger.commons.callback.IThrowingRunnable<EXTYPE> aRunnable)
                                                       throws EXTYPE extends Throwable

Throws:

EXTYPE extends Throwable

withDebugRender

public static <EXTYPE extends Throwable> void withDebugRender(boolean bDebug,
                                                              @Nonnull
                                                              com.helger.commons.callback.IThrowingRunnable<EXTYPE> aRunnable)
                                                       throws EXTYPE extends Throwable

Throws:

EXTYPE extends Throwable