com.aspc.cms.plugin

Class ArticleDataEntryPlugin

java.lang.Object

com.aspc.cms.plugin.ArticleDataEntryPlugin

All Implemented Interfaces:

ButtonBarPlugin, MakeHTMLComponentPlugin, ProcessParametersPlugin, ScreenWorkflowPlugin

public class ArticleDataEntryPlugin
extends java.lang.Object
implements ScreenWorkflowPlugin, ButtonBarPlugin, ProcessParametersPlugin, MakeHTMLComponentPlugin

Since:

28 November 2012

Author:

Lei Gao

Field Summary

Fields inherited from interface com.supertracker.ScreenObj.Plugin.ScreenWorkflowPlugin

SCREEN_ACTION_CLOSE, SCREEN_ACTION_DELETE, SCREEN_ACTION_EMAIL, SCREEN_ACTION_PRINT, SCREEN_ACTION_SAVE, SCREEN_ACTION_SAVE_AND_EXIT

Constructor Summary

Constructors

Constructor and Description
ArticleDataEntryPlugin(SDBScreen screen)

Method Summary

Modifier and Type	Method and Description
void	addButtons(SDBScreenContext context, HTMLPage page, java.lang.String next, java.util.ArrayList list) Add some more buttons.
void	addHiddenFields(SDBContext context, HTMLForm form) add hidden fields to the form
java.lang.String	determineScreenAction(SDBScreenContext context, java.lang.String nextAction) The action that is to be performed by the screen If no processing is required then the nextAction paramater should be returned without change
java.lang.String	getNextWindowTarget(SDBScreenContext context, java.lang.String target) The target window that should be used for nextWindowUrl If no processing is required then the target parameter should be returned without change
java.lang.String	getNextWindowUrl(SDBScreenContext context, java.lang.String url) The window that should be opened after screen processing has completed If no processing is required then the url parameter should be returned without change
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

ArticleDataEntryPlugin

public ArticleDataEntryPlugin(SDBScreen screen)

Method Detail

makeHTMLComponent

public HTMLComponent makeHTMLComponent(SDBContext context,
                                       SDBComponent screenComponent,
                                       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

addButtons

public void addButtons(SDBScreenContext context,
                       HTMLPage page,
                       java.lang.String next,
                       java.util.ArrayList list)

Description copied from interface: ButtonBarPlugin

Add some more buttons. You can add or remove buttons from the list.

Specified by:

addButtons in interface ButtonBarPlugin

Parameters:

context - the context

determineScreenAction

public java.lang.String determineScreenAction(SDBScreenContext context,
                                              java.lang.String nextAction)
                                       throws java.lang.Exception

Description copied from interface: ScreenWorkflowPlugin

The action that is to be performed by the screen If no processing is required then the nextAction paramater should be returned without change

Specified by:

determineScreenAction in interface ScreenWorkflowPlugin

Parameters:

context - - screen context containing information about the state of the screen

nextAction - - the default action

Returns:

What action the screen should take.

Throws:

java.lang.Exception - - processing cannot continue

getNextWindowUrl

public java.lang.String getNextWindowUrl(SDBScreenContext context,
                                         java.lang.String url)

Description copied from interface: ScreenWorkflowPlugin

The window that should be opened after screen processing has completed If no processing is required then the url parameter should be returned without change

Specified by:

getNextWindowUrl in interface ScreenWorkflowPlugin

Parameters:

context - - screen context containing information about the state of the screen

url - - the default url

Returns:

Url of next window

getNextWindowTarget

public java.lang.String getNextWindowTarget(SDBScreenContext context,
                                            java.lang.String target)

Description copied from interface: ScreenWorkflowPlugin

The target window that should be used for nextWindowUrl If no processing is required then the target parameter should be returned without change

Specified by:

getNextWindowTarget in interface ScreenWorkflowPlugin

Parameters:

context - - screen context containing information about the state of the screen

target - - the default target

Returns:

name of the target window

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