oracle.dss.thin.beans
Class ThinBeanDialog

java.lang.Object
  |
  +--oracle.dss.thin.beans.BaseThinBeanUI
        |
        +--oracle.dss.thin.beans.ThinBeanDialog

All Implemented Interfaces:

CheckpointState, ErrorHandlerCallback, ThinBean, ThinBeanUI

Direct Known Subclasses:

ExportOptions, FindMember, PrintOptions, SaveAs

public abstract class ThinBeanDialog

extends BaseThinBeanUI

A thin dialog. You normally render a thin dialog on its own page, adding OK and Cancel buttons or links to the page.

For information about incorporating thin dialogs in a servlet application, see BI Beans topics in the Help system. For example, look for the topic "Initializing BI Beans Thin Dialogs."

Field Summary

static java.lang.String	ALL_PAGES Export or Print range: All pages.
static java.lang.String	CURRENT_PAGE Export or Print range: Current page only.
static java.lang.String	SELECTED_PAGES Export or Print range: Selected pages.

Fields inherited from interface oracle.dss.thin.beans.ThinBeanUI

EVENT_HANDLED, EVENT_NOT_HANDLED, EVENT_RESPONSE_DONE

Constructor Summary

ThinBeanDialog()

Method Summary

void	addThinBeanDialogListener(ThinBeanDialogListener l) Adds a listener to this ThinBeanDialog.
int	handleEvent(QueryParameterProvider provider) Handles a thin-bean event.
void	removeThinBeanDialogListener(ThinBeanDialogListener l) Removes a listener from this ThinBeanDialog.

Methods inherited from class oracle.dss.thin.beans.BaseThinBeanUI

addErrorHandler, checkpointState, generateOnClickSubmit, getCheckpointState, getEventTarget, getLocale, getState, getThinBeanName, removeErrorHandler, setBaseState, setCheckpointState, setEventTarget, setLocale, setState, setThinBeanName

Methods inherited from class java.lang.Object

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

Field Detail

ALL_PAGES

public static final java.lang.String ALL_PAGES

Export or Print range: All pages. Export or print all logical pages of the view.

CURRENT_PAGE

public static final java.lang.String CURRENT_PAGE

Export or Print range: Current page only. Export or print the current logical page of the view.

SELECTED_PAGES

public static final java.lang.String SELECTED_PAGES

Export or Print range: Selected pages. Export or print selected logical pages of the view.

Constructor Detail

ThinBeanDialog

public ThinBeanDialog()

Method Detail

handleEvent

public int handleEvent(QueryParameterProvider provider)
                throws ThinException

Description copied from interface: ThinBeanUI

Handles a thin-bean event. This ThinBeanUI handles events where the value of the source query parameter is the ThinBeanName for this thin bean.

You can examine the source query parameter to determine the thin bean whose handleEvent to call. Or you can call the handleEvent for each thin bean, checking the return from this method to discover which thin bean handled the event. Alternately, you can register thin beans with the ServletRequestHandler and call the handleEvent method of the ServletRequestHandler. The ServletRequestHandler will then route the event to the proper thin bean.

For more information about thin-bean events, see the BI Beans Help system.

Following copied from interface: oracle.dss.thin.beans.ThinBeanUI

Parameters:

provider - The QueryParameterProvider for the HTTPServletRequest that is being handled.

Returns:

A constant that indicates whether this ThinBeanUI handled any events. Constants are listed in the See Also section.

Throws:

ThinException - If an error occurs that interrupts event handling.

See Also:

ThinBeanUI.EVENT_NOT_HANDLED, ThinBeanUI.EVENT_HANDLED, ThinBeanUI.EVENT_RESPONSE_DONE, ServletRequestHandler

addThinBeanDialogListener

public void addThinBeanDialogListener(ThinBeanDialogListener l)

Adds a listener to this ThinBeanDialog. Thin-bean dialogs send Java InitEvent objects to registered listeners. You can use this event to initialize a thin dialog that has been stored in the HttpSession.

Parameters:

l - The listener to add.

removeThinBeanDialogListener

public void removeThinBeanDialogListener(ThinBeanDialogListener l)

Removes a listener from this ThinBeanDialog.

Parameters:

l - The listener to remove.