org.apache.cocoon.woody.formmodel
Interface WidgetDefinition

All Known Subinterfaces:
ContainerDefinition
All Known Implementing Classes:
AbstractContainerDefinition, AbstractDatatypeWidgetDefinition, AbstractWidgetDefinition, ActionDefinition, AddRowActionDefinition, AggregateFieldDefinition, BooleanFieldDefinition, ClassDefinition, DeleteRowsActionDefinition, FieldDefinition, FormDefinition, MessagesDefinition, MultiValueFieldDefinition, NewDefinition, OutputDefinition, RepeaterActionDefinition, RepeaterDefinition, RowActionDefinition, RowActionDefinition.AddAfterDefinition, RowActionDefinition.DeleteRowDefinition, RowActionDefinition.MoveDownDefinition, RowActionDefinition.MoveUpDefinition, StructDefinition, SubmitDefinition, UnionDefinition, UploadDefinition

public interface WidgetDefinition

A WidgetDefinition holds all the static information about a Widget. It's function is a lot like that of the class in Java. Users of the Woody framework usually won't have to bother with the WidgetDefinition's, but will rather use the Widget's themselves.

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

Method Summary
 Widget createInstance()
          Creates and returns a widget based on this widget definition.
 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.
 void setParent(WidgetDefinition definition)
          Sets the parent of this definition
 

Method Detail

getFormDefinition

FormDefinition getFormDefinition()
Gets the FormDefinition.


setParent

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


getLocation

String getLocation()
Gets source location of this widget definition.


getId

String getId()
Gets id of this widget definition.


createInstance

Widget createInstance()
Creates and returns a widget based on this widget definition.


generateDisplayData

void generateDisplayData(String name,
                         ContentHandler contentHandler)
                         throws SAXException
Generates SAX events for named display data.

Throws:
SAXException

generateDisplayData

void generateDisplayData(ContentHandler contentHandler)
                         throws SAXException
Generates SAX events for display data.

Throws:
SAXException

generateLabel

void generateLabel(ContentHandler contentHandler)
                   throws SAXException
Generates SAX events for the label of this widget.

Throws:
SAXException


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