org.apache.cocoon.forms.formmodel
Class FieldDefinition

java.lang.Object
  extended byorg.apache.cocoon.forms.formmodel.AbstractWidgetDefinition
      extended byorg.apache.cocoon.forms.formmodel.AbstractDatatypeWidgetDefinition
          extended byorg.apache.cocoon.forms.formmodel.FieldDefinition
All Implemented Interfaces:
org.apache.cocoon.util.location.Locatable, WidgetDefinition
Direct Known Subclasses:
AggregateFieldDefinition, CalculatedFieldDefinition, CaptchaFieldDefinition, MultiValueFieldDefinition, RepeaterFilterFieldDefinition

public class FieldDefinition
extends AbstractDatatypeWidgetDefinition

The WidgetDefinition part of a Field widget, see Field for more information.

Version:
$Id: FieldDefinition.html 1304280 2012-03-23 11:18:01Z ilgrosso $

Field Summary
 
Fields inherited from class org.apache.cocoon.forms.formmodel.AbstractWidgetDefinition
createListener, enclosingLibrary, parent
 
Constructor Summary
FieldDefinition()
           
 
Method Summary
 Widget createInstance()
          Creates and returns a widget based on this widget definition.
 SelectionList getSuggestionList()
           
 Whitespace getWhitespaceTrim()
           
 void initializeFrom(WidgetDefinition definition)
          initialize this definition with the other, sort of like a copy constructor
 boolean isRequired()
           
 void setRequired(boolean required)
           
 void setSuggestionList(SelectionList list)
           
 void setWhitespaceTrim(Whitespace whitespaceTrim)
           
 
Methods inherited from class org.apache.cocoon.forms.formmodel.AbstractDatatypeWidgetDefinition
addValueChangedListener, buildSelectionList, buildSelectionListFromModel, checkCompleteness, fireValueChangedEvent, getDatatype, getInitialValue, getSelectionList, getValueChangedListener, hasValueChangedListeners, setDatatype, setProcessInfoProvider, setSelectionList, setSourceResolver, setXmlizer
 
Methods inherited from class org.apache.cocoon.forms.formmodel.AbstractWidgetDefinition
addCreateListener, addValidator, checkMutable, fireCreateEvent, generateDisplayData, generateDisplayData, generateLabel, getAttribute, getEnclosingLibrary, getFormDefinition, getId, getLocation, getParent, getState, makeImmutable, setAttributes, setDisplayData, setEnclosingLibrary, setId, setLocation, setParent, setState, validate, widgetCreated
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FieldDefinition

public FieldDefinition()
Method Detail

createInstance

public Widget createInstance()
Description copied from interface: WidgetDefinition
Creates and returns a widget based on this widget definition.


initializeFrom

public void initializeFrom(WidgetDefinition definition)
                    throws Exception
initialize this definition with the other, sort of like a copy constructor

Specified by:
initializeFrom in interface WidgetDefinition
Overrides:
initializeFrom in class AbstractDatatypeWidgetDefinition
Throws:
Exception

isRequired

public boolean isRequired()

setRequired

public void setRequired(boolean required)

getWhitespaceTrim

public Whitespace getWhitespaceTrim()

setWhitespaceTrim

public void setWhitespaceTrim(Whitespace whitespaceTrim)

getSuggestionList

public SelectionList getSuggestionList()

setSuggestionList

public void setSuggestionList(SelectionList list)


Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.