com.primix.tapestry.inspector
Class Inspector

java.lang.Object
  |
  +--com.primix.tapestry.AbstractComponent
        |
        +--com.primix.tapestry.BaseComponent
              |
              +--com.primix.tapestry.AbstractPage
                    |
                    +--com.primix.tapestry.BasePage
                          |
                          +--com.primix.tapestry.inspector.Inspector
All Implemented Interfaces:
IComponent, IPage, IRender

public class Inspector
extends BasePage

The Tapestry Inspector page.

Version:
$Id: Inspector.java,v 1.18 2001/10/08 18:28:40 hship Exp $
Author:
Howard Ship

Fields inherited from class com.primix.tapestry.AbstractPage
engine, name
 
Fields inherited from class com.primix.tapestry.BaseComponent
outer, OUTER_INIT_SIZE, outerCount
 
Fields inherited from class com.primix.tapestry.AbstractComponent
id, page, specification, wrapped, wrappedCount
 
Constructor Summary
Inspector()
           
 
Method Summary
 void detach()
          Prepares the page to be returned to the pool.
 void finishLoad(IPageLoader loader, ComponentSpecification specification)
          Allows a component to finish any setup after it has been constructed.
 Block getBlockForView()
          Returns the Block for the currently selected view.
 java.lang.Object getExploredObject()
          Returns the object currently being explored.
 java.lang.String getExplorePath()
           
 IComponent getInspectedComponent()
          Returns the IComponent current inspected; this is determined from the inspectedPageName and inspectedIdPath properties.
 java.lang.String getInspectedIdPath()
           
 IPage getInspectedPage()
          Returns the IPage currently inspected by the Inspector, as determined from the inspectedPageName property.
 java.lang.String getInspectedPageName()
           
 java.lang.String getInspectorTitle()
           
 View getView()
           
 void inspect(java.lang.String pageName, IRequestCycle cycle)
          Method invoked by the ShowInspector component, to begin inspecting a page.
 void selectComponent(java.lang.String idPath)
          Invoked to change the component being inspected within the current page.
 void selectComponent(java.lang.String[] context, IRequestCycle cycle)
          Listener for the component selection, which allows a particular component.
 void setExplorePath(java.lang.String value)
           
 void setInspectedIdPath(java.lang.String value)
           
 void setInspectedPageName(java.lang.String value)
           
 void setView(View value)
           
 
Methods inherited from class com.primix.tapestry.BasePage
getResponseWriter
 
Methods inherited from class com.primix.tapestry.AbstractPage
addPageCleanupListener, addPageDetachListener, addPageRenderListener, attach, beginResponse, cleanupPage, firePageBeginRender, firePageCleanup, firePageDetached, firePageEndRender, getChangeObserver, getEngine, getExtendedId, getIdPath, getLocale, getName, getNestedComponent, getPage, getRequestCycle, getVisit, renderPage, setChangeObserver, setLocale, setName, setRequestCycle, validate
 
Methods inherited from class com.primix.tapestry.BaseComponent
addOuter, readTemplate, render
 
Methods inherited from class com.primix.tapestry.AbstractComponent
addAsset, addComponent, addWrapped, cleanupAfterRender, cleanupComponent, finishLoad, fireObservedChange, fireObservedChange, fireObservedChange, fireObservedChange, fireObservedChange, fireObservedChange, fireObservedChange, fireObservedChange, fireObservedChange, fireObservedChange, generateAttributes, getAsset, getAssets, getBeans, getBinding, getBindingNames, getBindings, getComponent, getComponents, getContainer, getId, getListeners, getSpecification, prepareForRender, renderWrapped, reset, setBinding, setContainer, setId, setPage, setSpecification, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.primix.tapestry.IComponent
addAsset, addComponent, addWrapped, getAsset, getAssets, getBinding, getBindingNames, getBindings, getComponent, getComponents, getContainer, getId, getSpecification, renderWrapped, setBinding, setContainer, setId, setPage, setSpecification
 
Methods inherited from interface com.primix.tapestry.IRender
render
 

Constructor Detail

Inspector

public Inspector()
Method Detail

detach

public void detach()
Description copied from class: AbstractPage
Prepares the page to be returned to the pool.

Subclasses may override this method, but must invoke this implementation (usually, last).

Overrides:
detach in class AbstractPage
Following copied from interface: com.primix.tapestry.IPage
See Also:
IPageSource.releasePage(IPage)

finishLoad

public void finishLoad(IPageLoader loader,
                       ComponentSpecification specification)
                throws PageLoaderException
Description copied from interface: IComponent
Allows a component to finish any setup after it has been constructed.

The exact timing is not specified, but any components contained by the receiving component will also have been constructed before this method is invoked.

As of release 1.0.6, this method is invoked before bindings are set. This should not affect anything, as bindings should only be used during renderring.

Overrides:
finishLoad in class BaseComponent

getView

public View getView()

setView

public void setView(View value)

getInspectedPageName

public java.lang.String getInspectedPageName()

setInspectedPageName

public void setInspectedPageName(java.lang.String value)

getInspectedIdPath

public java.lang.String getInspectedIdPath()

setInspectedIdPath

public 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. This should be used, not setInspectedIdPath(String), since this also sets the explore path to null.
Since:
1.0.6

getExplorePath

public java.lang.String getExplorePath()
Since:
1.0.6

setExplorePath

public void setExplorePath(java.lang.String value)

inspect

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

selectComponent

public void selectComponent(java.lang.String[] context,
                            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 java.lang.String getInspectorTitle()

getExploredObject

public java.lang.Object getExploredObject()
Returns the object currently being explored. This is either the inspected component, or an object retrieved from it via the explorePath.
Since:
1.0.6

getBlockForView

public Block getBlockForView()
Returns the Block for the currently selected view.