Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 2 (11.1.2.0.0)
E17488-01


oracle.adf.view.rich.context
Class DialogService

java.lang.Object
  extended by oracle.adf.view.rich.context.DialogService


public abstract class DialogService
extends java.lang.Object

Largely a mirror for the Trinidad DialogService, this class also contains additional DialogService functionality that is only exposed by the rich client framework. Developers should only use two of the methods published by this interface. The others are reserved for internal use by the framework only.

See Also:
launchDialog(javax.faces.component.UIViewRoot, java.util.Map<java.lang.String, java.lang.Object>, javax.faces.component.UIComponent, boolean, java.util.Map<java.lang.String, java.lang.Object>), returnFromDialog(java.lang.Object, java.util.Map<java.lang.Object, java.lang.Object>)

Constructor Summary
DialogService()
           

 

Method Summary
abstract  javax.faces.component.UIComponent getCurrentLaunchSource()
          The direct use of this API is reserved for an interface between layers of the Fusion stack and should not be directly called by an application.
abstract  java.util.Map<java.lang.String,java.lang.Object> getInitialDialogParameters()
          The direct use of this API is reserved for an interface between layers of the Fusion stack and should not be directly called by an application.
abstract  org.apache.myfaces.trinidad.event.ReturnEvent getReturnEvent(javax.faces.component.UIComponent source)
          Deprecated. For internal use only and only exposed in support of the legacy Trinidad dialog framework API.
abstract  boolean isDialogInNewWindow()
          The direct use of this API is reserved for an interface between layers of the Fusion stack and should not be directly called by an application.
abstract  void launchDialog(javax.faces.component.UIViewRoot dialogRoot, java.util.Map<java.lang.String,java.lang.Object> dialogParameters, javax.faces.component.UIComponent source, boolean useWindow, java.util.Map<java.lang.String,java.lang.Object> windowProperties)
          Launches a dialog without pushing a process scope.
abstract  javax.faces.component.UIViewRoot peekView()
          Deprecated. For internal use only and only exposed in support of the legacy Trinidad dialog framework API. When ADFc page flows are in the runtime classpath, this is non-functional. Note: the JDEV compile time classpath will not be the same as the runtime classpath with the Fusion stack running under Weblogic Server (WLS).
abstract  void popView(boolean navigateToPopped)
          Deprecated. For internal use only and only exposed in support of the legacy Trinidad dialog framework API. When ADFc page flows are in the runtime classpath, this is non-functional. Note: the JDEV compile time classpath will not be the same as the runtime classpath with the Fusion stack running under Weblogic Server (WLS).
abstract  void pushView(javax.faces.component.UIViewRoot viewRoot)
          Deprecated. For internal use only and only exposed in support of the legacy Trinidad dialog framework API. When ADFc page flows are in the runtime classpath, this is non-functional. Note: the JDEV compile time classpath will not be the same as the runtime classpath with the Fusion stack running under Weblogic Server (WLS).
abstract  void queueLaunchEvent(javax.faces.component.UIViewRoot dialogRoot)
          The direct use of this API is reserved for an interface between layers of the Fusion stack and should not be directly called by an application.
abstract  void queueNewWindowLaunchEvent(java.lang.String viewId)
          The direct use of this API is reserved for an interface between layers of the Fusion stack and should not be directly called by an application.
abstract  void queueReturnEvent(java.lang.Object returnValue, java.util.Map<java.lang.Object,java.lang.Object> returnParams)
          The direct use of this API is reserved for an interface between layers of the Fusion stack and should not be directly called by an application.
abstract  boolean returnFromDialog(java.lang.Object returnValue, java.util.Map<java.lang.Object,java.lang.Object> returnParameters)
          Returns from a dialog without popping a process scope.
abstract  void setCurrentLaunchSource(javax.faces.component.UIComponent component)
          Deprecated. For internal use only and only exposed in support of the legacy Trinidad dialog framework API.

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

DialogService

public DialogService()

Method Detail

pushView

@Deprecated
public abstract void pushView(javax.faces.component.UIViewRoot viewRoot)
Deprecated. For internal use only and only exposed in support of the legacy Trinidad dialog framework API. When ADFc page flows are in the runtime classpath, this is non-functional. Note: the JDEV compile time classpath will not be the same as the runtime classpath with the Fusion stack running under Weblogic Server (WLS).

popView

@Deprecated
public abstract void popView(boolean navigateToPopped)
Deprecated. For internal use only and only exposed in support of the legacy Trinidad dialog framework API. When ADFc page flows are in the runtime classpath, this is non-functional. Note: the JDEV compile time classpath will not be the same as the runtime classpath with the Fusion stack running under Weblogic Server (WLS).

peekView

@Deprecated
public abstract javax.faces.component.UIViewRoot peekView()
Deprecated. For internal use only and only exposed in support of the legacy Trinidad dialog framework API. When ADFc page flows are in the runtime classpath, this is non-functional. Note: the JDEV compile time classpath will not be the same as the runtime classpath with the Fusion stack running under Weblogic Server (WLS).

getReturnEvent

@Deprecated
public abstract org.apache.myfaces.trinidad.event.ReturnEvent getReturnEvent(javax.faces.component.UIComponent source)
Deprecated. For internal use only and only exposed in support of the legacy Trinidad dialog framework API.

getCurrentLaunchSource

public abstract javax.faces.component.UIComponent getCurrentLaunchSource()

The direct use of this API is reserved for an interface between layers of the Fusion stack and should not be directly called by an application.


setCurrentLaunchSource

@Deprecated
public abstract void setCurrentLaunchSource(javax.faces.component.UIComponent component)
Deprecated. For internal use only and only exposed in support of the legacy Trinidad dialog framework API.

launchDialog

public abstract void launchDialog(javax.faces.component.UIViewRoot dialogRoot,
                                  java.util.Map<java.lang.String,java.lang.Object> dialogParameters,
                                  javax.faces.component.UIComponent source,
                                  boolean useWindow,
                                  java.util.Map<java.lang.String,java.lang.Object> windowProperties)
Launches a dialog without pushing a process scope. This method should only be used by controller framework code; all others should use AdfFacesContext.launchDialog(). The process scope must be pushed before calling this method.

returnFromDialog

public abstract boolean returnFromDialog(java.lang.Object returnValue,
                                         java.util.Map<java.lang.Object,java.lang.Object> returnParameters)
Returns from a dialog without popping a process scope. This method should only be used by controller framework code; all others should use AdfFacesContext.returnFromDialog(). The process scope must be popped after calling this method.
Returns:
true if pages accessing that dialog are necessarily permanently inaccessible. For example, a dialog displayed in a popup window is inacessible once the window has closed, but a dialog displayed within the same window might be reached by the back button.

queueLaunchEvent

public abstract void queueLaunchEvent(javax.faces.component.UIViewRoot dialogRoot)

The direct use of this API is reserved for an interface between layers of the Fusion stack and should not be directly called by an application.


queueReturnEvent

public abstract void queueReturnEvent(java.lang.Object returnValue,
                                      java.util.Map<java.lang.Object,java.lang.Object> returnParams)

The direct use of this API is reserved for an interface between layers of the Fusion stack and should not be directly called by an application.


isDialogInNewWindow

public abstract boolean isDialogInNewWindow()

The direct use of this API is reserved for an interface between layers of the Fusion stack and should not be directly called by an application.


queueNewWindowLaunchEvent

public abstract void queueNewWindowLaunchEvent(java.lang.String viewId)

The direct use of this API is reserved for an interface between layers of the Fusion stack and should not be directly called by an application.


getInitialDialogParameters

public abstract java.util.Map<java.lang.String,java.lang.Object> getInitialDialogParameters()

The direct use of this API is reserved for an interface between layers of the Fusion stack and should not be directly called by an application.


Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 2 (11.1.2.0.0)
E17488-01


Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved.