echoxul.view.builder
Class AbstractEchoXULElement

java.lang.Object
  echoxul.xom.XULNode
      echoxul.xom.XULElement
          echoxul.view.builder.AbstractEchoXULElement

Direct Known Subclasses:

AbstractHtmlEchoXULElement, ComponentEchoXULElement, XULBoxElement

public abstract class AbstractEchoXULElement

extends XULElement

This base class is derived from to create all XULElements which produce echo components. This includes sub classes that wrap actual Echo components as well as those which produce HTML or XUL entities.

Author:

Terry Laurenzo

Constructor Summary

AbstractEchoXULElement()
Create an XULElement that supports children

Method Summary

abstract nextapp.echo.Component	createComponent(BuilderContext context) This method is called to create the Echo component which is represented by this XUL definition.
protected java.lang.String	filterDefaultAttributeName(java.lang.String name) Translates attribute names from the attribute default namespace.
protected java.lang.String	getBindingName()
protected java.lang.RuntimeException	newException(java.lang.String message) Convenience method for subclasses to create exceptions that include the source file location.

Methods inherited from class echoxul.xom.XULElement

addChild, dump, dumpChildren, getAttributes, getChildren, getCssClasses, getDocument, getId, getName, getNamespace, getParent, hasChildren, init, lockChildren, setParameters, supportsChildren

Methods inherited from class echoxul.xom.XULNode

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractEchoXULElement

public AbstractEchoXULElement()

Create an XULElement that supports children

Method Detail

getBindingName

protected java.lang.String getBindingName()

Returns:

The name to bind as or null if none

createComponent

public abstract nextapp.echo.Component createComponent(BuilderContext context)

This method is called to create the Echo component which is represented by this XUL definition. It should recursively call its children as necessary.

Parameters:

context - for manipulating the resource hierarchy.

Returns:

Newly created Echo Component

newException

protected java.lang.RuntimeException newException(java.lang.String message)

Convenience method for subclasses to create exceptions that include the source file location.

Parameters:

message -

Returns:

filterDefaultAttributeName

protected java.lang.String filterDefaultAttributeName(java.lang.String name)

Translates attribute names from the attribute default namespace. If the attribute name is an internal XUL attribute, null will be returned. Internal attributes can be represented with the syntax prefix "esc.". The esc. will be stripped and the altered name returned. Otherwise, the name will be returned unchanged.

Parameters:

name -

Returns: