org.springframework.extensions.surf.types

Class SurfBugImpl

java.lang.Object

org.springframework.extensions.surf.types.AbstractModelObject

org.springframework.extensions.surf.render.AbstractRenderableModelObject

org.springframework.extensions.surf.types.SurfBugImpl

All Implemented Interfaces:

Serializable, ModelObject, Renderable, ResourceProvider, SurfBug

public class SurfBugImpl
extends AbstractRenderableModelObject
implements SurfBug

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

Author:

David Draper

See Also:

Serialized Form

Field Summary

Fields inherited from class org.springframework.extensions.surf.render.AbstractRenderableModelObject

PROP_PROCESSOR

Fields inherited from class org.springframework.extensions.surf.types.AbstractModelObject

customProperties, description, descriptionId, id, info, modelProperties, modificationTime, resourceContainer, title, titleId

Fields inherited from interface org.springframework.extensions.surf.types.SurfBug

PROP_SURFBUG_TYPE, TYPE_ID

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

PROP_DESCRIPTION, PROP_DESCRIPTION_ID, PROP_ID, PROP_TITLE, PROP_TITLE_ID

Constructor Summary

Constructors

Constructor and Description
SurfBugImpl(String id, ModelPersisterInfo key, org.dom4j.Document document)

Method Summary

Methods

Modifier and Type	Method and Description
Component	getCurrentComponent() Return the Component currently being debugged.
String	getSurfBugType()
String	getTypeId() Returns the type id of the model object.
boolean	hasBeenDebugged(Component object) Indicates whether or not the supplied Component has already been debugged.
void	setCurrentComponent(Component component) Set the Component currently being debugged.
void	setSurfBugType(String surfbugType)

Methods inherited from class org.springframework.extensions.surf.render.AbstractRenderableModelObject

getProcessorId, getProcessorId, getProcessorProperties, getProcessorProperties, getProcessorProperty, getProcessorProperty, getRenderModes

Methods inherited from class org.springframework.extensions.surf.types.AbstractModelObject

addResource, addResource, getBooleanProperty, getCustomProperties, getCustomProperty, getDescription, getDescriptionId, getDocument, getId, getKey, getModelProperties, getModelProperty, getModificationTime, getPersisterId, getProperties, getProperty, getResource, getResourceContainer, getResources, getResourcesMap, getStoragePath, getTitle, getTitleId, isCustomProperty, isModelProperty, isSaved, removeCustomProperty, removeModelProperty, removeProperty, removeResource, setCustomProperty, setDescription, setDescriptionId, setId, setModelProperty, setModificationTime, setProperty, setTitle, setTitleId, toString, touch, toXML, updateResource, updateXML

Methods inherited from class java.lang.Object

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

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, isSaved, removeCustomProperty, removeModelProperty, removeProperty, setCustomProperty, setDescription, setDescriptionId, setModelProperty, setProperty, setTitle, setTitleId, touch, toXML

Constructor Detail

SurfBugImpl

public SurfBugImpl(String id,
           ModelPersisterInfo key,
           org.dom4j.Document document)

Method Detail

getTypeId

public String getTypeId()

Description copied from interface: ModelObject

Returns the type id of the model object.

Specified by:

getTypeId in interface ModelObject

Specified by:

getTypeId in class AbstractModelObject

Returns:

The type id

getSurfBugType

public String getSurfBugType()

Specified by:

getSurfBugType in interface SurfBug

setSurfBugType

public void setSurfBugType(String surfbugType)

Specified by:

setSurfBugType in interface SurfBug

setCurrentComponent

public void setCurrentComponent(Component component)

Set the Component currently being debugged.

Specified by:

setCurrentComponent in interface SurfBug

Parameters:

component - Component

hasBeenDebugged

public boolean hasBeenDebugged(Component object)

Indicates whether or not the supplied Component has already been debugged. This will return true if the supplied Component matches the currentComponent instance variable.

Specified by:

hasBeenDebugged in interface SurfBug

Parameters:

object - boolean

Returns:

Component

getCurrentComponent

public Component getCurrentComponent()

Return the Component currently being debugged.

Specified by:

getCurrentComponent in interface SurfBug

Returns:

Component