org.springframework.extensions.surf.types

Interface SurfBug

All Superinterfaces:

ModelObject, Serializable

All Known Implementing Classes:

SurfBugImpl

public interface SurfBug
extends ModelObject

A SurfBug object is used for writing debug HTML to the output stream when SurfBug mode is enabled.

Author:

David Draper

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROP_SURFBUG_TYPE
static String	TYPE_ID

Fields inherited from interface org.springframework.extensions.surf.ModelObject

PROP_DESCRIPTION, PROP_DESCRIPTION_ID, PROP_ID, PROP_TITLE, PROP_TITLE_ID

Method Summary

Methods

Modifier and Type	Method and Description
Component	getCurrentComponent() Should return the Component currently being debugged.
String	getSurfBugType()
boolean	hasBeenDebugged(Component object) Should return a boolean value indicating whether or not the supplied Component has already been debugged
void	setCurrentComponent(Component component) Should set the Component currently being debugged.
void	setSurfBugType(String surfBugType)

Methods inherited from interface org.springframework.extensions.surf.ModelObject

getBooleanProperty, getCustomProperties, getCustomProperty, getDescription, getDescriptionId, getDocument, getId, getKey, getModelProperties, getModelProperty, getModificationTime, getPersisterId, getProperties, getProperty, getStoragePath, getTitle, getTitleId, getTypeId, isSaved, removeCustomProperty, removeModelProperty, removeProperty, setCustomProperty, setDescription, setDescriptionId, setModelProperty, setProperty, setTitle, setTitleId, touch, toXML

Field Detail

TYPE_ID

static final String TYPE_ID

See Also:

Constant Field Values

PROP_SURFBUG_TYPE

static final String PROP_SURFBUG_TYPE

See Also:

Constant Field Values

Method Detail

getSurfBugType

String getSurfBugType()

setSurfBugType

void setSurfBugType(String surfBugType)

setCurrentComponent

void setCurrentComponent(Component component)

Should set the Component currently being debugged.

Parameters:

component - Component

getCurrentComponent

Component getCurrentComponent()

Should return the Component currently being debugged.

Returns:

Component

hasBeenDebugged

boolean hasBeenDebugged(Component object)

Should return a boolean value indicating whether or not the supplied Component has already been debugged

Parameters:

object - Component

Returns:

boolean