|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.alfresco.repo.forms.processor.AbstractFormProcessor
org.alfresco.repo.forms.processor.FilteredFormProcessor
org.alfresco.repo.forms.processor.action.ActionFormProcessor
public class ActionFormProcessor
This class is a FormProcessor
for actions
.
Field Summary | |
---|---|
protected static java.lang.String |
EXECUTE_ASYNCHRONOUSLY
|
static java.lang.String |
ITEM_KIND
|
Fields inherited from class org.alfresco.repo.forms.processor.FilteredFormProcessor |
---|
fieldProcessorRegistry, filterRegistry |
Fields inherited from class org.alfresco.repo.forms.processor.AbstractFormProcessor |
---|
active, DESTINATION, matchPattern, patternMatcher, processorRegistry |
Constructor Summary | |
---|---|
ActionFormProcessor()
|
Method Summary | |
---|---|
protected java.util.List |
generateDefaultFields(FormCreationData data,
java.util.List fieldsToIgnore)
Generates a list of default fields to add if no field names are specified. |
protected java.util.List |
generateSelectedFields(java.util.List requestedFields,
FormCreationData data)
|
protected java.util.List |
getDefaultIgnoredFields()
When a Form is generated with no field names specifically set then a default Form is created. |
protected java.lang.String |
getItemType(ActionDefinition item)
Returns a String describing the type fo the specified item. |
protected java.lang.String |
getItemURI(ActionDefinition item)
Returns the URI location of the specified item. |
protected org.apache.commons.logging.Log |
getLogger()
Retrieves a logger instance to log to. |
protected ActionDefinition |
getTypedItem(Item item)
Returns a typed Object representing the given item. |
protected ActionFormResult |
internalPersist(ActionDefinition item,
FormData data)
Persists the form data. |
protected java.lang.Object |
makeItemData(ActionDefinition item)
Creates a data object used by the FormProcessor and FieldProcessors to create Fields |
void |
setActionService(ActionService actionService)
|
void |
setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)
|
void |
setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService)
|
Methods inherited from class org.alfresco.repo.forms.processor.FilteredFormProcessor |
---|
generate, internalGenerate, persist, populateForm, setFieldProcessorRegistry, setFilterRegistry, setIgnoredFields |
Methods inherited from class org.alfresco.repo.forms.processor.AbstractFormProcessor |
---|
isActive, isApplicable, register, setActive, setFormItemType, setFormItemUrl, setMatchPattern, setProcessorRegistry, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String ITEM_KIND
protected static final java.lang.String EXECUTE_ASYNCHRONOUSLY
Constructor Detail |
---|
public ActionFormProcessor()
Method Detail |
---|
public void setActionService(ActionService actionService)
public void setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)
public void setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService)
protected org.apache.commons.logging.Log getLogger()
FilteredFormProcessor
getLogger
in class FilteredFormProcessor
protected ActionDefinition getTypedItem(Item item)
FilteredFormProcessor
Subclasses that represent a form type will return a typed object that is then passed to each of it's handlers, the handlers can therefore safely cast the Object to the type they expect.
getTypedItem
in class FilteredFormProcessor
item
- The item to get a typed object for
protected java.lang.String getItemType(ActionDefinition item)
FilteredFormProcessor
String
describing the type fo the specified item.
getItemType
in class FilteredFormProcessor
protected java.lang.String getItemURI(ActionDefinition item)
FilteredFormProcessor
getItemURI
in class FilteredFormProcessor
protected ActionFormResult internalPersist(ActionDefinition item, FormData data)
FilteredFormProcessor
internalPersist
in class FilteredFormProcessor
item
- The object to persist the form fordata
- The data to persist
protected java.util.List generateDefaultFields(FormCreationData data, java.util.List fieldsToIgnore)
FilteredFormProcessor
generateDefaultFields
in class FilteredFormProcessor
data
- Used for field creation.
List
of Fields
which may be empty.protected java.util.List generateSelectedFields(java.util.List requestedFields, FormCreationData data)
generateSelectedFields
in class FilteredFormProcessor
protected java.util.List getDefaultIgnoredFields()
FilteredFormProcessor
Form
is generated with no field names specifically set then a default Form
is created.
The default Form
contains all the properties and associations related to the Item
, excluding a
blacklist of ignored fields which defaults to the return value of this method.
The default ignored values can be overridden by setting the property ignoredFields
.
getDefaultIgnoredFields
in class FilteredFormProcessor
Form
if no defaultFields
property is explicitly set.protected java.lang.Object makeItemData(ActionDefinition item)
FilteredFormProcessor
FormProcessor
and FieldProcessors
to create Fields
makeItemData
in class FilteredFormProcessor
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |