com.aspc.pref.screen

Class PreferencePortalPlugin

java.lang.Object

com.aspc.pref.screen.PreferencePortalPlugin

All Implemented Interfaces:

ButtonBarPlugin, MakeHTMLComponentPlugin, ProcessParametersPlugin

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

Controls the components that appear in the portal of column preferences THREAD MODE: MULTI-THREADED screen plug-in

Since:

November 28 2005

Author:

Jason McGrath

Constructor Summary

Constructors

Constructor and Description
PreferencePortalPlugin() constructor
PreferencePortalPlugin(SDBScreen scrn) PreferencePortalPlugin constructor

Method Summary

Modifier and Type	Method and Description
void	addButtons(SDBScreenContext context, HTMLPage page, java.lang.String next, java.util.ArrayList list) Add buttons to a button bar
void	addHiddenFields(SDBContext context, HTMLForm form) add hidden fields
HTMLComponent	makeHTMLComponent(SDBContext context, SDBComponent screenComponent, HTMLComponent htmlComponent) Extend the generation of an HTMLcompnent
void	postProcessParameters(WebClient client, DBObject base) The main purpose of this procedure is to ensure that the screen shows a column preference for each component on the screen invoice.
void	preProcessParameters(WebClient client, DBObject base) pre-process parameters
void	setProcessParametersAttribute(WebClient client, FormData fd) set the parameters
void	setProcessParametersOrder(WebClient client, java.util.ArrayList orderedList) set the parameters

Methods inherited from class java.lang.Object

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

Constructor Detail

PreferencePortalPlugin

public PreferencePortalPlugin(SDBScreen scrn)

PreferencePortalPlugin constructor

Parameters:

scrn - - Screen that this plugin is applicable to

PreferencePortalPlugin

public PreferencePortalPlugin()

constructor

Method Detail

preProcessParameters

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

pre-process parameters

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 main purpose of this procedure is to ensure that the screen shows a column preference for each component on the screen invoice.

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 parameters

Specified by:

setProcessParametersAttribute in interface ProcessParametersPlugin

Parameters:

client - the web client

fd - the client

Throws:

java.lang.Exception - a serious problem

setProcessParametersOrder

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

set the parameters

Specified by:

setProcessParametersOrder in interface ProcessParametersPlugin

Parameters:

client - the web client

orderedList - the ordered list

Throws:

java.lang.Exception - a serious problem

addHiddenFields

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

add hidden fields

Specified by:

addHiddenFields in interface ProcessParametersPlugin

Parameters:

context - the context

form - the form

Throws:

java.lang.Exception - a serious problem

makeHTMLComponent

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

Extend the generation of an HTMLcompnent

Specified by:

makeHTMLComponent in interface MakeHTMLComponentPlugin

Parameters:

context - - the current screen context

screenComponent - - The screen component that the HTMLComponent is generated from

htmlComponent - - System generated HTML component

Returns:

the HTML component to be palced on a screen

Throws:

java.lang.Exception - - a serious error

addButtons

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

Add buttons to a button bar

Specified by:

addButtons in interface ButtonBarPlugin

Parameters:

context - the screen context

page - the HTML page

next - next

list - the list of buttons