org.apache.cocoon.woody.formmodel
Class AbstractWidgetDefinition

java.lang.Object
  extended by org.apache.cocoon.woody.formmodel.AbstractWidgetDefinition
All Implemented Interfaces:
WidgetDefinition
Direct Known Subclasses:
AbstractContainerDefinition, AbstractDatatypeWidgetDefinition, ActionDefinition, BooleanFieldDefinition, MessagesDefinition, NewDefinition, UploadDefinition

public abstract class AbstractWidgetDefinition
extends Object
implements WidgetDefinition

Provides functionality that is common across many WidgetDefinition implementations.

Version:
$Id: AbstractWidgetDefinition.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Field Summary
protected  WidgetDefinition parent
           
 
Constructor Summary
AbstractWidgetDefinition()
           
 
Method Summary
 void addValidator(WidgetValidator validator)
           
 void generateDisplayData(ContentHandler contentHandler)
          Generates SAX events for display data.
 void generateDisplayData(String name, ContentHandler contentHandler)
          Generates SAX events for named display data.
 void generateLabel(ContentHandler contentHandler)
          Generates SAX events for the label of this widget.
 FormDefinition getFormDefinition()
          Gets the FormDefinition.
 String getId()
          Gets id of this widget definition.
 String getLocation()
          Gets source location of this widget definition.
 WidgetDefinition getParent()
          Gets the parent of this definition.
 void setDisplayData(Map displayData)
          Sets the various display data for this widget.
protected  void setId(String id)
           
protected  void setLocation(String location)
           
 void setParent(WidgetDefinition definition)
          Sets the parent of this definition
 boolean validate(Widget widget, FormContext context)
          Validate a widget using the validators that were defined in its definition.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.cocoon.woody.formmodel.WidgetDefinition
createInstance
 

Field Detail

parent

protected WidgetDefinition parent
Constructor Detail

AbstractWidgetDefinition

public AbstractWidgetDefinition()
Method Detail

getFormDefinition

public FormDefinition getFormDefinition()
Description copied from interface: WidgetDefinition
Gets the FormDefinition.

Specified by:
getFormDefinition in interface WidgetDefinition

setParent

public void setParent(WidgetDefinition definition)
Sets the parent of this definition

Specified by:
setParent in interface WidgetDefinition

getParent

public WidgetDefinition getParent()
Gets the parent of this definition. This method returns null for the root definition.


setLocation

protected void setLocation(String location)

getLocation

public String getLocation()
Description copied from interface: WidgetDefinition
Gets source location of this widget definition.

Specified by:
getLocation in interface WidgetDefinition

getId

public String getId()
Description copied from interface: WidgetDefinition
Gets id of this widget definition.

Specified by:
getId in interface WidgetDefinition

setId

protected void setId(String id)

generateLabel

public void generateLabel(ContentHandler contentHandler)
                   throws SAXException
Description copied from interface: WidgetDefinition
Generates SAX events for the label of this widget.

Specified by:
generateLabel in interface WidgetDefinition
Throws:
SAXException

setDisplayData

public void setDisplayData(Map displayData)
Sets the various display data for this widget. This includes the label, hint and help. They must all be objects implementing the XMLizable interface. This approach allows to have mixed content in these data.

Parameters:
displayData - an association of {name, sax fragment}

addValidator

public void addValidator(WidgetValidator validator)

generateDisplayData

public void generateDisplayData(String name,
                                ContentHandler contentHandler)
                         throws SAXException
Description copied from interface: WidgetDefinition
Generates SAX events for named display data.

Specified by:
generateDisplayData in interface WidgetDefinition
Throws:
SAXException

generateDisplayData

public void generateDisplayData(ContentHandler contentHandler)
                         throws SAXException
Description copied from interface: WidgetDefinition
Generates SAX events for display data.

Specified by:
generateDisplayData in interface WidgetDefinition
Throws:
SAXException

validate

public boolean validate(Widget widget,
                        FormContext context)
Validate a widget using the validators that were defined in its definition. If validation fails, the validator has set a validation error on the widget or one of its children.

Parameters:
widget - the widget
context - the form context
Returns:
true if validation was successful.


Copyright © 1999-2010 The Apache Software Foundation. All Rights Reserved.