oracle.dss.thin.beans
Interface EventTarget

All Known Implementing Classes:

EventTargetImpl

public interface EventTarget

EventTargets are used to define the following properties of ThinBeanUI events:

• destination URI, which can be used to change the servlet or JSP that the event is sent to.
• target frame, which can be used to specify the name of the HTML frame that the results of the event should be rendered into.
• ThinBean target, which can be used to change the name of the ThinBean that the event is delivered to. NOTE : The query parameter that identified the name of the ThinBean to deliver the event to is actually called "source" instead of "target".
• extra query parameters, which can be used to specify query parameter names and values that are event specific. This can be useful when application defined query parameters need to change for a specific event. Applications that need to specify the page to render within query parameters may find this feature very useful.

Method Summary

java.lang.String	getDestination() Retrieves the destination URI that the event is sent to.
java.util.Dictionary	getExtraEventParameters() Retrieves extra event parameters that should be added to the event.
java.lang.String	getTargetFrame() Retrieves the name of the HTML frame that the event is executed within.
java.lang.String	getThinBeanTarget() Retrieves the name of the ThinBeanUI instance that will handle this event.

Method Detail

getDestination

public java.lang.String getDestination()

Retrieves the destination URI that the event is sent to. If this property is null, then events are sent to either:

• the URI that was defined in the form that contains the ThinBeanUI instance.
• the URI for the current browser window, if a hyperlink is being generated

Returns:

the destination URI for the event

getTargetFrame

public java.lang.String getTargetFrame()

Retrieves the name of the HTML frame that the event is executed within. If this property is null, then events are sent to the HTML frame that contains the rendered ThinBeanUI.

Returns:

the target frame that the event is executed in

getThinBeanTarget

public java.lang.String getThinBeanTarget()

Retrieves the name of the ThinBeanUI instance that will handle this event. If this property is null, then events are sent to the same ThinBeanUI instance that rendered the event.

Returns:

the name ThinBeanUI instance that handles the event

getExtraEventParameters

public java.util.Dictionary getExtraEventParameters()

Retrieves extra event parameters that should be added to the event. If this property is null, then no extra event parameters are added.

Returns:

a Dictionary of event parameters (query parameter name - query parameter value pairs)