wt.templateutil.table
Class HTMLTableServiceEvent

java.lang.Object
  java.util.EventObject
      wt.templateutil.table.HTMLTableServiceEvent

All Implemented Interfaces:

Serializable

public class HTMLTableServiceEvent

extends EventObject

This class represents the event fired off when a call from Windchill script of the form

tableService action=...

is performed.

The information from the Windchill script call, namely the parameter, the locale, and the OutputStream, are passed into this event along with an instance of a TemplateProcessorTableService as the source object.

The TemplateProcessorTableService encapsulates additional information that can be used by the implementors of the HTMLTableServiceEventListener interface. Some of the additional information that is maintained by the TemplateProcessorTableService instance is

• The current HTMLTable instance using the HTML Table Service
• The current HTTPState object of the Template Processor generating the page
• messageResource - The ResourceBundle used to for generating the "No Results" message
• messageKey used - The key in the ResourceBundle to the "No Results" message

To get the instance of the TemplateProcessorTableService used, call the getSource method.

See Also:

Serialized Form

Field Summary

private String	action
private Locale	locale
private OutputStream	outputStream
private Properties	parameters
private HTTPState	state

Fields inherited from class java.util.EventObject

source

Constructor Summary

HTMLTableServiceEvent(Object source)
Constructor required by inheritence.

Method Summary

String	getAction() Gets the action that is defined in the Windchill script call for the tableService.
Locale	getLocale() Gets the locale to be used in the HTML Table Service for a given Windchill script call.
OutputStream	getOutputStream()
Properties	getParameters() Gets the Properties to be used in the HTML Table Service for a given Windchill script call.
HTTPState	getState()
void	refresh() Refreshes the HTMLTableServiceEvent instance after each Windchill script call.
void	setAction(String newAction) Sets the action that is defined in the Windchill script call for the tableService.
void	setEvent(String action, Locale locale, OutputStream os, Properties props) Sets the state of the event for each Windchill script call.
void	setLocale(Locale newlocale) Sets the locale to be used in the HTML Table Service for a given Windchill script call.
void	setOutputStream(OutputStream newOutputStream)
void	setParameters(Properties newParameters) Sets the Properties to be used in the HTML Table Service for a given Windchill script call.
void	setState(HTTPState state)

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Field Detail

action

private String action

locale

private Locale locale

outputStream

private OutputStream outputStream

parameters

private Properties parameters

state

private HTTPState state

Constructor Detail

HTMLTableServiceEvent

public HTMLTableServiceEvent(Object source)

Constructor required by inheritence. The source object has to be an instance of TemplateProcessorTableService.

Parameters:

source - - TemplateProcessorTableService instance

Method Detail

refresh

public void refresh()

Refreshes the HTMLTableServiceEvent instance after each Windchill script call. This is required as the same event object is re-used for the life of the TemplateProcessorTableService that is generating it.

The following items are "refreshed"

• The action - from the Windchill script call
• The Locale - from the Windchill script call
• The OutputStream - from the Windchill script call
• The parameter - from the Windchill script call

setEvent

public void setEvent(String action,
                     Locale locale,
                     OutputStream os,
                     Properties props)

Sets the state of the event for each Windchill script call.

Parameters:

action -

locale -

os -

props -

setAction

public void setAction(String newAction)

Sets the action that is defined in the Windchill script call for the tableService.

Parameters:

newAction -

getAction

public String getAction()

Gets the action that is defined in the Windchill script call for the tableService.

Returns:

String

setLocale

public void setLocale(Locale newlocale)

Sets the locale to be used in the HTML Table Service for a given Windchill script call.

Parameters:

newlocale -

getLocale

public Locale getLocale()

Gets the locale to be used in the HTML Table Service for a given Windchill script call.

Returns:

Locale

setOutputStream

public void setOutputStream(OutputStream newOutputStream)

getOutputStream

public OutputStream getOutputStream()

setParameters

public void setParameters(Properties newParameters)

Sets the Properties to be used in the HTML Table Service for a given Windchill script call.

Parameters:

newParameters -

getParameters

public Properties getParameters()

Gets the Properties to be used in the HTML Table Service for a given Windchill script call.

setState

public void setState(HTTPState state)

getState

public HTTPState getState()