com.aspc.cms.component.plugins

Class SiteComponentDataEntryPlugin

java.lang.Object

com.aspc.cms.component.plugins.SiteComponentDataEntryPlugin

All Implemented Interfaces:

MakeHTMLComponentPlugin, ProcessParametersPlugin

Direct Known Subclasses:

FormDataEntryPlugin, HtmlTextComponentDataEntryPlugin

public class SiteComponentDataEntryPlugin
extends java.lang.Object
implements ProcessParametersPlugin, MakeHTMLComponentPlugin

Since:

2 Dec 2013

Author:

Liam Itzhaki

Constructor Summary

Constructors

Constructor and Description
SiteComponentDataEntryPlugin(SDBScreen screen)

Method Summary

Modifier and Type	Method and Description
void	addHiddenFields(SDBContext context, HTMLForm form) add hidden fields to the form
HTMLComponent	makeHTMLComponent(SDBContext context, SDBComponent screenComponent, HTMLComponent htmlComponent) Extend the generation of an HTMLcompnent
void	postProcessParameters(WebClient client, DBObject base) The data entry screen will call this method AFTER building the universe.
void	preProcessParameters(WebClient client, DBObject base) The data entry screen will call this method BEFORE building the universe from the parameters passed.
void	setProcessParametersAttribute(WebClient client, FormData fd) set the attribute
void	setProcessParametersOrder(WebClient client, java.util.ArrayList orderedList) set the order

Methods inherited from class java.lang.Object

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

Constructor Detail

SiteComponentDataEntryPlugin

public SiteComponentDataEntryPlugin(SDBScreen screen)

Method Detail

makeHTMLComponent

public HTMLComponent makeHTMLComponent(@Nonnull
                                       SDBContext context,
                                       @Nonnull
                                       SDBComponent screenComponent,
                                       @Nonnull
                                       HTMLComponent htmlComponent)
                                throws java.lang.Exception

Description copied from interface: MakeHTMLComponentPlugin

Extend the generation of an HTMLcompnent

Specified by:

makeHTMLComponent in interface MakeHTMLComponentPlugin

Parameters:

context - the context

Returns:

the HTML component to be palced on a screen

Throws:

java.lang.Exception - a serious problem

preProcessParameters

public void preProcessParameters(WebClient client,
                                 DBObject base)
                          throws java.lang.Exception

The data entry screen will call this method BEFORE building the universe from the parameters passed. At this stage we may add and remove parameters to the client.

Specified by:

preProcessParameters in interface ProcessParametersPlugin

Parameters:

client - the web client

base - the base object

Throws:

java.lang.Exception - a serious problem

postProcessParameters

public void postProcessParameters(WebClient client,
                                  DBObject base)
                           throws java.lang.Exception

The data entry screen will call this method AFTER building the universe. You may create additional records etc. before the screen is layout

Specified by:

postProcessParameters in interface ProcessParametersPlugin

Parameters:

client - the web client

base - the base object

Throws:

java.lang.Exception - a serious problem

setProcessParametersAttribute

public void setProcessParametersAttribute(WebClient client,
                                          FormData fd)
                                   throws java.lang.Exception

set the attribute

Specified by:

setProcessParametersAttribute in interface ProcessParametersPlugin

Parameters:

client - the web client

fd - form data

Throws:

java.lang.Exception - a serious problem

setProcessParametersOrder

public void setProcessParametersOrder(WebClient client,
                                      java.util.ArrayList orderedList)
                               throws java.lang.Exception

set the order

Specified by:

setProcessParametersOrder in interface ProcessParametersPlugin

Parameters:

client - the web client

orderedList - the list

Throws:

java.lang.Exception - a serious problem

addHiddenFields

public void addHiddenFields(SDBContext context,
                            HTMLForm form)
                     throws java.lang.Exception

add hidden fields to the form

Specified by:

addHiddenFields in interface ProcessParametersPlugin

Parameters:

context - the context

form - the form

Throws:

java.lang.Exception - a serious problem