Constructor Detail

• MetawidgetTag

  public MetawidgetTag()

Method Detail

• setPageContext

  public void setPageContext(javax.servlet.jsp.PageContext newPageContext)

  Specified by:

  setPageContext in interface javax.servlet.jsp.tagext.Tag

  Overrides:

  setPageContext in class javax.servlet.jsp.tagext.TagSupport

• getPath

  public String getPath()

• getPathPrefix

  public String getPathPrefix()

• setConfig

  public void setConfig(String config)

• getLabelString

  public String getLabelString(Map<String,String> attributes)

  Returns a label for the given set of attributes.

  The label is determined using the following algorithm:

  • if attributes.get( "label" ) exists...
    • attributes.get( "label" ) is camel-cased and used as a lookup into getLocalizedKey( camelCasedLabel ). This means developers can initially build their UIs without worrying about localization, then turn it on later
    • if no such lookup exists, return attributes.get( "label" )
  • if attributes.get( "label" ) does not exist...
    • attributes.get( "name" ) is used as a lookup into getLocalizedKey( name )
    • if no such lookup exists, return attributes.get( "name" )

• getLocalizedKey

  public String getLocalizedKey(String key)

  Returns:

  null if no bundle, ???key??? if bundle is missing a key

• getFacet

  public FacetTag getFacet(String name)

• setFacet

  public void setFacet(String name,
              FacetTag facetTag)

• setStub

  public void setStub(String path,
             StubTag stubTag)

• isReadOnly

  public boolean isReadOnly()

• setReadOnly

  public void setReadOnly(boolean readOnly)

• setInspector

  public void setInspector(Inspector inspector)

• inspect

  public String inspect(Object toInspect,
               String type,
               String... names)

  Useful for WidgetBuilders to perform nested inspections (eg. for Collections).

• setInspectionResultProcessors

  public void setInspectionResultProcessors(InspectionResultProcessor<MetawidgetTag>... inspectionResultProcessors)

• setWidgetBuilder

  public void setWidgetBuilder(WidgetBuilder<Object,? extends MetawidgetTag> widgetBuilder)

• setWidgetProcessors

  public void setWidgetProcessors(WidgetProcessor<javax.servlet.jsp.tagext.Tag,MetawidgetTag>... widgetProcessors)

• getLayout

  public Layout<javax.servlet.jsp.tagext.Tag,javax.servlet.jsp.tagext.BodyTag,MetawidgetTag> getLayout()

  Useful for WidgetBuilders.

• setLayout

  public void setLayout(Layout<javax.servlet.jsp.tagext.Tag,javax.servlet.jsp.tagext.BodyTag,MetawidgetTag> layout)

• getPageContext

  public javax.servlet.jsp.PageContext getPageContext()

  This method is public for use by WidgetBuilders to perform nested inspections (eg. for Collections).

• putClientProperty

  public void putClientProperty(Object key,
                       Object value)

  Storage area for WidgetProcessors, Layouts, and other stateless clients.

• getClientProperty

  public <T> T getClientProperty(Object key)

  Storage area for WidgetProcessors, Layouts, and other stateless clients.

• doStartTag

  public int doStartTag()
                 throws javax.servlet.jsp.JspException

  Specified by:

  doStartTag in interface javax.servlet.jsp.tagext.Tag

  Overrides:

  doStartTag in class javax.servlet.jsp.tagext.BodyTagSupport

  Throws:

  javax.servlet.jsp.JspException

• doEndTag

  public int doEndTag()
               throws javax.servlet.jsp.JspException

  Specified by:

  doEndTag in interface javax.servlet.jsp.tagext.Tag

  Overrides:

  doEndTag in class javax.servlet.jsp.tagext.BodyTagSupport

  Throws:

  javax.servlet.jsp.JspException

• getStub

  public StubTag getStub(String path)

  Fetch a StubTag with the given path.

  This is an internal API exposed for OverriddenWidgetBuilder. Clients should not call it directly.

• setPathInternal

  protected void setPathInternal(String path)

  Sets the path.

  Set by subclasses according to what they prefer to call it (eg. name for Struts, property for Spring).

• setPathPrefix

  protected void setPathPrefix(String pathPrefix)

• setBundle

  protected void setBundle(ResourceBundle bundle)

  Sets the ResourceBundle used to localize labels.

  This will need to be exposed in framework-specific ways. For example, JSTL can use LocalizationContexts, though these are not necessarily available to a Struts app.

• newPipeline

  protected W3CPipeline<javax.servlet.jsp.tagext.Tag,javax.servlet.jsp.tagext.BodyTag,MetawidgetTag> newPipeline()

  Instantiate the Pipeline used by this Metawidget.

  Subclasses wishing to use their own Pipeline should override this method to instantiate their version.

• beforeBuildCompoundWidget

  protected abstract void beforeBuildCompoundWidget(Element element)

• initNestedMetawidget

  protected void initNestedMetawidget(MetawidgetTag nestedMetawidget,
                          Map<String,String> attributes)

• inspect

  protected Element inspect()

• getDefaultConfiguration

  protected abstract String getDefaultConfiguration()