org.apache.tapestry.contrib.inspector

Class ShowSpecification

java.lang.Object

org.apache.hivemind.impl.BaseLocatable

org.apache.tapestry.AbstractComponent

org.apache.tapestry.BaseComponent

org.apache.tapestry.contrib.inspector.ShowSpecification

All Implemented Interfaces:

java.util.EventListener, org.apache.hivemind.Locatable, org.apache.hivemind.LocationHolder, org.apache.tapestry.event.PageBeginRenderListener, org.apache.tapestry.event.PageEndRenderListener, org.apache.tapestry.IComponent, org.apache.tapestry.IRender, org.apache.tapestry.ITemplateComponent

public abstract class ShowSpecification
extends org.apache.tapestry.BaseComponent
implements org.apache.tapestry.event.PageBeginRenderListener, org.apache.tapestry.event.PageEndRenderListener

Component of the Inspector page used to display the specification, parameters and bindings and assets of the inspected component.

Author:

Howard Lewis Ship

Constructor Summary

Constructors

Constructor and Description
ShowSpecification()

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.tapestry.IAsset	getAsset() Returns the IAsset corresponding to the value of the assetName property.
java.lang.String	getAssetName()
java.util.List	getAssetNames() Returns a sorted list of asset names, or null if the component contains no assets.
java.lang.String	getBeanName()
java.util.List	getBeanNames()
org.apache.tapestry.spec.IBeanSpecification	getBeanSpecification()
org.apache.tapestry.IBinding	getBinding() Returns the IBinding corresponding to the value of the parameterName property.
abstract org.apache.tapestry.IComponent	getCurrentComponent()
java.util.List	getFormalParameterNames() Returns a sorted list of formal parameter names.
java.util.List	getInformalParameterNames() Returns a sorted list of informal parameter names.
org.apache.tapestry.IComponent	getInspectedComponent()
org.apache.tapestry.spec.IComponentSpecification	getInspectedSpecification()
java.lang.String	getParameterName()
org.apache.tapestry.spec.IParameterSpecification	getParameterSpecification() Returns the ParameterSpecification corresponding to the value of the parameterName property.
java.lang.String	getPropertyName()
java.lang.String	getPropertyValue()
java.util.List	getSortedComponents()
java.util.List	getSortedPropertyNames() Returns a list of the properties for the component (from its specification), or null if the component has no properties.
void	pageBeginRender(org.apache.tapestry.event.PageEvent event) Gets the inspected component and specification from the Inspector page.
void	pageEndRender(org.apache.tapestry.event.PageEvent event) Clears all cached information about the component and such after each render (including the rewind phase render used to process the tab view).
void	setAssetName(java.lang.String value)
void	setBeanName(java.lang.String value)
abstract void	setCurrentComponent(org.apache.tapestry.IComponent value)
void	setParameterName(java.lang.String value)
void	setPropertyName(java.lang.String value)

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, finishLoad, format, format, format, format, getAsset, getAssets, getBeans, getBinding, getBindingNames, getBindings, getBody, getBodyCount, getComponent, getComponents, getContainedComponent, getContainer, getExtendedId, getId, getIdPath, getListeners, getMessage, getMessages, getNamespace, getPage, getProperty, getSpecification, isInActiveState, isParameterBound, isRendering, 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, getAsset, getAssets, getBeans, getBinding, getBindingNames, getBindings, getComponent, getComponents, getContainedComponent, getContainer, getExtendedId, getId, getIdPath, 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

ShowSpecification

public ShowSpecification()

Method Detail

pageEndRender

public void pageEndRender(org.apache.tapestry.event.PageEvent event)

Clears all cached information about the component and such after each render (including the rewind phase render used to process the tab view).

Specified by:

pageEndRender in interface org.apache.tapestry.event.PageEndRenderListener

Overrides:

pageEndRender in class org.apache.tapestry.AbstractComponent

Since:

1.0.5

pageBeginRender

public void pageBeginRender(org.apache.tapestry.event.PageEvent event)

Gets the inspected component and specification from the Inspector page.

Specified by:

pageBeginRender in interface org.apache.tapestry.event.PageBeginRenderListener

Since:

1.0.5

getInspectedComponent

public org.apache.tapestry.IComponent getInspectedComponent()

getInspectedSpecification

public org.apache.tapestry.spec.IComponentSpecification getInspectedSpecification()

getFormalParameterNames

public java.util.List getFormalParameterNames()

Returns a sorted list of formal parameter names.

getInformalParameterNames

public java.util.List getInformalParameterNames()

Returns a sorted list of informal parameter names. This is the list of all bindings, with the list of parameter names removed, sorted.

getParameterName

public java.lang.String getParameterName()

setParameterName

public void setParameterName(java.lang.String value)

getParameterSpecification

public org.apache.tapestry.spec.IParameterSpecification getParameterSpecification()

Returns the ParameterSpecification corresponding to the value of the parameterName property.

getBinding

public org.apache.tapestry.IBinding getBinding()

Returns the IBinding corresponding to the value of the parameterName property.

setAssetName

public void setAssetName(java.lang.String value)

getAssetName

public java.lang.String getAssetName()

getAsset

public org.apache.tapestry.IAsset getAsset()

Returns the IAsset corresponding to the value of the assetName property.

getAssetNames

public java.util.List getAssetNames()

Returns a sorted list of asset names, or null if the component contains no assets.

getSortedComponents

public java.util.List getSortedComponents()

setCurrentComponent

public abstract void setCurrentComponent(org.apache.tapestry.IComponent value)

getCurrentComponent

public abstract org.apache.tapestry.IComponent getCurrentComponent()

getSortedPropertyNames

public java.util.List getSortedPropertyNames()

Returns a list of the properties for the component (from its specification), or null if the component has no properties.

setPropertyName

public void setPropertyName(java.lang.String value)

getPropertyName

public java.lang.String getPropertyName()

getPropertyValue

public java.lang.String getPropertyValue()

getBeanNames

public java.util.List getBeanNames()

setBeanName

public void setBeanName(java.lang.String value)

getBeanName

public java.lang.String getBeanName()

getBeanSpecification

public org.apache.tapestry.spec.IBeanSpecification getBeanSpecification()