org.apache.tapestry.contrib.inspector
Class Inspector

java.lang.Object
  extended by org.apache.hivemind.impl.BaseLocatable
      extended by org.apache.tapestry.AbstractComponent
          extended by org.apache.tapestry.BaseComponent
              extended by org.apache.tapestry.AbstractPage
                  extended by org.apache.tapestry.html.BasePage
                      extended by org.apache.tapestry.contrib.inspector.Inspector
All Implemented Interfaces:
org.apache.hivemind.Locatable, org.apache.hivemind.LocationHolder, org.apache.tapestry.IComponent, org.apache.tapestry.IPage, org.apache.tapestry.IRender, org.apache.tapestry.ITemplateComponent

public abstract class Inspector
extends org.apache.tapestry.html.BasePage

The Tapestry Inspector page.

Author:
Howard Lewis Ship

Constructor Summary
Inspector()
           
 
Method Summary
protected  void finishLoad()
           
 org.apache.tapestry.components.Block getBlockForView()
          Returns the Block for the currently selected view.
 org.apache.tapestry.IComponent getInspectedComponent()
          Returns the IComponent current inspected; this is determined from the inspectedPageName and inspectedIdPath properties.
abstract  java.lang.String getInspectedIdPath()
           
 org.apache.tapestry.IPage getInspectedPage()
          Returns the IPage currently inspected by the Inspector, as determined from the inspectedPageName property.
abstract  java.lang.String getInspectedPageName()
           
 java.lang.String getInspectorTitle()
           
abstract  java.lang.String getView()
           
 void inspect(java.lang.String pageName, org.apache.tapestry.IRequestCycle cycle)
          Method invoked by the InspectorButton component, to begin inspecting a page.
 void selectComponent(org.apache.tapestry.IRequestCycle cycle)
          Listener for the component selection, which allows a particular component.
 void selectComponent(java.lang.String idPath)
          Invoked to change the component being inspected within the current page.
abstract  void setInspectedIdPath(java.lang.String value)
           
abstract  void setInspectedPageName(java.lang.String value)
           
abstract  void setView(java.lang.String value)
           
 
Methods inherited from class org.apache.tapestry.html.BasePage
getResponseContentType
 
Methods inherited from class org.apache.tapestry.AbstractPage
addPageAttachListener, addPageBeginRenderListener, addPageDetachListener, addPageEndRenderListener, addPageRenderListener, addPageValidateListener, attach, beginPageRender, beginResponse, detach, endPageRender, firePageAttached, firePageBeginRender, firePageDetached, firePageEndRender, firePageValidate, getChangeObserver, getEngine, getExtendedId, getGlobal, getIdPath, getLocale, getNestedComponent, getOutputEncoding, getPageName, getRequestCycle, getVisit, initialize, removePageAttachListener, removePageBeginRenderListener, removePageDetachListener, removePageEndRenderListener, removePageRenderListener, removePageValidateListener, renderPage, setChangeObserver, setLocale, setPageName, validate
 
Methods inherited from class org.apache.tapestry.BaseComponent
addOuter, finishLoad, renderComponent
 
Methods inherited from class org.apache.tapestry.AbstractComponent
addAsset, addBody, addComponent, checkActiveLock, cleanupAfterRender, enterActiveState, format, format, format, format, getAsset, getAssets, getBeans, getBinding, getBindingNames, getBindings, getBody, getBodyCount, getComponent, getComponents, getContainedComponent, getContainer, getId, getListeners, getMessage, getMessages, getNamespace, getPage, getProperty, getSpecification, isInActiveState, isParameterBound, isRendering, pageEndRender, prepareForRender, render, renderBody, renderInformalParameters, setBinding, setContainedComponent, setContainer, setId, setNamespace, setPage, setProperty, toString
 
Methods inherited from class org.apache.hivemind.impl.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, enterActiveState, finishLoad, getAsset, getAssets, getBeans, getBinding, getBindingNames, getBindings, getComponent, getComponents, getContainedComponent, getContainer, getId, getListeners, getMessage, getMessages, getNamespace, getPage, getProperty, getSpecification, isRendering, renderBody, setBinding, setContainedComponent, setContainer, setId, setNamespace, setPage, setProperty
 
Methods inherited from interface org.apache.tapestry.IRender
render
 
Methods inherited from interface org.apache.hivemind.LocationHolder
setLocation
 
Methods inherited from interface org.apache.hivemind.Locatable
getLocation
 

Constructor Detail

Inspector

public Inspector()
Method Detail

finishLoad

protected void finishLoad()
Overrides:
finishLoad in class org.apache.tapestry.AbstractComponent

getView

public abstract java.lang.String getView()

setView

public abstract void setView(java.lang.String value)

getInspectedPageName

public abstract java.lang.String getInspectedPageName()

setInspectedPageName

public abstract void setInspectedPageName(java.lang.String value)

getInspectedIdPath

public abstract java.lang.String getInspectedIdPath()

setInspectedIdPath

public abstract void setInspectedIdPath(java.lang.String value)

selectComponent

public void selectComponent(java.lang.String idPath)
Invoked to change the component being inspected within the current page.

Since:
1.0.6

inspect

public void inspect(java.lang.String pageName,
                    org.apache.tapestry.IRequestCycle cycle)
Method invoked by the InspectorButton component, to begin inspecting a page.


selectComponent

public void selectComponent(org.apache.tapestry.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 org.apache.tapestry.IPage getInspectedPage()
Returns the IPage currently inspected by the Inspector, as determined from the inspectedPageName property.


getInspectedComponent

public org.apache.tapestry.IComponent getInspectedComponent()
Returns the IComponent current inspected; this is determined from the inspectedPageName and inspectedIdPath properties.


getInspectorTitle

public java.lang.String getInspectorTitle()

getBlockForView

public org.apache.tapestry.components.Block getBlockForView()
Returns the Block for the currently selected view.