org.apache.tapestry.contrib.inspector
Class Inspector

java.lang.Object
  org.apache.tapestry.spec.BaseLocatable
      org.apache.tapestry.AbstractComponent
          org.apache.tapestry.BaseComponent
              org.apache.tapestry.AbstractPage
                  org.apache.tapestry.html.BasePage
                      org.apache.tapestry.contrib.inspector.Inspector

All Implemented Interfaces:

IComponent, ILocatable, ILocationHolder, IPage, IRender

public abstract class Inspector
extends BasePage

The Tapestry Inspector page.

Version:

$Id: Inspector.java 243791 2004-02-19 17:38:13Z hlship $

Author:

Howard Lewis Ship

Constructor Summary

Inspector()

Method Summary

protected void	finishLoad() Invoked, as a convienience, from AbstractComponent.finishLoad(IRequestCycle, IPageLoader, IComponentSpecification).
Block	getBlockForView() Returns the Block for the currently selected view.
IComponent	getInspectedComponent() Returns the IComponent current inspected; this is determined from the inspectedPageName and inspectedIdPath properties.
abstract String	getInspectedIdPath()
IPage	getInspectedPage() Returns the IPage currently inspected by the Inspector, as determined from the inspectedPageName property.
abstract String	getInspectedPageName()
String	getInspectorTitle()
abstract View	getView()
void	inspect(String pageName, IRequestCycle cycle) Method invoked by the InspectorButton component, to begin inspecting a page.
void	selectComponent(IRequestCycle cycle) Listener for the component selection, which allows a particular component.
void	selectComponent(String idPath) Invoked to change the component being inspected within the current page.
abstract void	setInspectedIdPath(String value)
abstract void	setInspectedPageName(String value)
abstract void	setView(View value)

Methods inherited from class org.apache.tapestry.html.BasePage

getResponseWriter

Methods inherited from class org.apache.tapestry.AbstractPage

addPageDetachListener, addPageRenderListener, addPageValidateListener, attach, beginPageRender, beginResponse, detach, endPageRender, firePageBeginRender, firePageDetached, firePageEndRender, firePageValidate, getChangeObserver, getEngine, getExtendedId, getGlobal, getIdPath, getLocale, getNestedComponent, getOutputEncoding, getPageName, getRequestCycle, getVisit, initialize, removePageDetachListener, removePageRenderListener, removePageValidateListener, renderPage, setChangeObserver, setLocale, setPageName, setRequestCycle, validate

Methods inherited from class org.apache.tapestry.BaseComponent

addOuter, finishLoad, renderComponent

Methods inherited from class org.apache.tapestry.AbstractComponent

addAsset, addBody, addComponent, cleanupAfterRender, fireObservedChange, fireObservedChange, fireObservedChange, fireObservedChange, fireObservedChange, fireObservedChange, fireObservedChange, fireObservedChange, fireObservedChange, format, format, format, format, formatString, formatString, formatString, formatString, generateAttributes, getAsset, getAssets, getBeans, getBinding, getBindingNames, getBindings, getBody, getBodyCount, getComponent, getComponents, getContainer, getId, getListeners, getMessage, getMessages, getNamespace, getPage, getProperty, getSpecification, getString, pageEndRender, prepareForRender, render, renderBody, renderInformalParameters, setBinding, setContainer, setId, setNamespace, setPage, setProperty, setSpecification, toString

Methods inherited from class org.apache.tapestry.spec.BaseLocatable

getLocation, setLocation

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.tapestry.IComponent

addAsset, addBody, addComponent, finishLoad, getAsset, getAssets, getBinding, getBindingNames, getBindings, getComponent, getComponents, getContainer, getId, getMessage, getMessages, getNamespace, getPage, getProperty, getSpecification, getString, renderBody, setBinding, setContainer, setId, setNamespace, setPage, setProperty, setSpecification

Methods inherited from interface org.apache.tapestry.IRender

render

Methods inherited from interface org.apache.tapestry.ILocationHolder

setLocation

Methods inherited from interface org.apache.tapestry.ILocatable

getLocation

Constructor Detail

Inspector

public Inspector()

Method Detail

finishLoad

protected void finishLoad()

Description copied from class: AbstractComponent

Invoked, as a convienience, from AbstractComponent.finishLoad(IRequestCycle, IPageLoader, IComponentSpecification). This implemenation does nothing. Subclasses may override without invoking this implementation.

Overrides:

finishLoad in class AbstractComponent

getView

public abstract View getView()

setView

public abstract void setView(View value)

getInspectedPageName

public abstract String getInspectedPageName()

setInspectedPageName

public abstract void setInspectedPageName(String value)

getInspectedIdPath

public abstract String getInspectedIdPath()

setInspectedIdPath

public abstract void setInspectedIdPath(String value)

selectComponent

public void selectComponent(String idPath)

Invoked to change the component being inspected within the current page.

Since:

1.0.6

inspect

public void inspect(String pageName,
                    IRequestCycle cycle)

Method invoked by the InspectorButton component, to begin inspecting a page.

selectComponent

public void selectComponent(IRequestCycle cycle)

Listener for the component selection, which allows a particular component.

The context is a single string, the id path of the component to be selected (or null to inspect the page itself). This invokes selectComponent(String).

getInspectedPage

public IPage getInspectedPage()

Returns the IPage currently inspected by the Inspector, as determined from the inspectedPageName property.

getInspectedComponent

public IComponent getInspectedComponent()

Returns the IComponent current inspected; this is determined from the inspectedPageName and inspectedIdPath properties.

getInspectorTitle

public String getInspectorTitle()

getBlockForView

public Block getBlockForView()

Returns the Block for the currently selected view.