oracle.apps.fnd.applcore.patterns.ui.util
Class PatternsUtil

java.lang.Object
  oracle.apps.fnd.applcore.patterns.ui.util.PatternsUtil

public class PatternsUtil
extends java.lang.Object

Patterns Utility class for Applcore internal use only.

Constructor Summary

PatternsUtil()

Method Summary

static java.lang.String	constructPageParamsForNav(java.lang.String pageParametersList)
static java.lang.String	constructParamsForURL(java.util.Map parametersMap)
static java.lang.String	constructParamStrFormMap(java.util.Map parametersMap)
static java.lang.Object	evaluateEL(java.lang.String el)
static java.lang.String	evaluateELStringInParamList(java.lang.String elString) This api takes parameterList separated by semicolon and then evaluates each parameter value if it starts with #.
static javax.faces.component.UIComponent	findComponentById(javax.faces.component.UIComponent parent, java.lang.String id) Find a component by ID when parent and searched component are passed.
static java.lang.Object	findNodeByPropertyValue(org.apache.myfaces.trinidad.model.BaseMenuModel tree, java.lang.String myVal, java.lang.String myProp)
static ApplicationsMenuModel	getActiveViewAppsMenuModel() Gets the ApplicationsMenuModel for the current view
static java.lang.String	getAppsTableChildComponentAbsoluteId(oracle.adf.view.rich.component.fragment.UIXDeclarativeComponent appsComp, java.lang.String componentId) Returns the absolute id of the component inside the panelCollection of ApplicationsTable.
static java.lang.String	getAppsTableChildComponentAbsoluteId(oracle.adf.view.rich.component.fragment.UIXPageTemplate appsComp, java.lang.String componentId) Deprecated. replaced by getAppsTableChildComponentAbsoluteId(UIXDeclarativeComponent, String)
static java.lang.String	getAppsTreeChildComponentAbsoluteId(oracle.adf.view.rich.component.fragment.UIXDeclarativeComponent appsComp, java.lang.String componentId) Returns the absolute id of the component inside the panelCollection of ApplicationsTable.
static java.lang.String	getAppsTreeChildComponentAbsoluteId(oracle.adf.view.rich.component.fragment.UIXPageTemplate appsComp, java.lang.String componentId) Deprecated. replaced by getAppsTreeChildComponentAbsoluteId(UIXDeclarativeComponent, String)
static java.lang.String	getAttribute(java.lang.String attrName, oracle.adf.view.rich.component.fragment.UIXDeclarativeComponent appsComponent) Returns the attribute value of the attribute.
static java.lang.String	getAttribute(java.lang.String attrName, oracle.adf.view.rich.component.fragment.UIXPageTemplate appsComponent) Deprecated. replaced by #getAttribute(UIXDeclarativeComponent)
static java.lang.String	getComponentAbsoluteId(oracle.adf.view.rich.component.fragment.UIXDeclarativeComponent appsComp, java.lang.String componentId) Returns the absolute id of the component.
static org.apache.myfaces.trinidad.model.BaseMenuModel	getCurrentDistributedMenuModel(java.lang.String menuMode) Get the most current Distributed Menu Model after checking security for the logged in user.
static java.lang.String	getCurrentUIShellWindowId()
static java.lang.String	getDocumentRoot()
static ItemNode	getFocusItemNode(org.apache.myfaces.trinidad.model.BaseMenuModel menuModel)
static org.apache.myfaces.trinidad.model.BaseMenuModel	getNonSecuredDistributedMenuModel(java.lang.String menuMode) Get the most current Distributed Menu Model without checking security for the logged in user.
static javax.faces.component.UIComponent	getParentByType(javax.faces.component.UIComponent child, java.lang.Class parentType) Searches the parent hierarchy of the child for UIComponent of type parentType.
static javax.faces.component.UIComponent	getParentByTypeAndId(javax.faces.component.UIComponent child, java.lang.Class parentType, java.lang.String id) Searches the parent hierarchy of the child for UIComponent of type parentType and local id id.
static SimpleMenuNode	getPreferenceNode()
static java.util.List<ItemNode>	getTasks(org.apache.myfaces.trinidad.model.XMLMenuModel menuModel)
static java.lang.String	getViewId(org.apache.myfaces.trinidad.model.XMLMenuModel menuModel) Get the View ID
static java.lang.String	getWebAppName(org.apache.myfaces.trinidad.model.XMLMenuModel menuModel) Get the Web Application Name
static void	invokePopup(java.lang.String popupId) Deprecated. As of ATGPF Drop5Prime, replaced by PatternsPublicUtil#invokePopup(String)
static boolean	isChangeIndicatorColumn(oracle.jbo.server.AttributeDefImpl attrDef) Method for examining if an attribute is a unique key column
static boolean	isEditingUIShellTemplate(ApplSession applSession) Determine whether the UIShell Template page is being edited.
static boolean	isHistoryColumn(oracle.jbo.server.AttributeDefImpl attrDef) Method for examining if an attribute is a history column
static boolean	isHomePage()
static boolean	isUniqueKeyColumn(oracle.jbo.server.AttributeDefImpl attrDef) Method for examining if an attribute is a unique key column
static void	launchSaveWarningPopup(java.lang.String message)
static java.util.Map	resolveKeyMap(java.lang.String keyList, java.util.Map parametersMap) Given parametersMap and list of key parameters, returns a new Map containing just the key-value pairs.
static java.util.Map	resolveParametersMap(java.lang.String parametersMapEL, java.lang.String parametersList) Merge parameter definitions and return a unified Map.
static void	setHomePageWindowTitle(java.lang.String taskTitle)
static void	setWindowTitle(java.lang.String taskTitle)
static void	setWindowTitle(java.lang.String tasklabel, java.lang.String workAreaLabel)

Methods inherited from class java.lang.Object

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

Constructor Detail

PatternsUtil

public PatternsUtil()

Method Detail

getParentByType

public static javax.faces.component.UIComponent getParentByType(javax.faces.component.UIComponent child,
                                                                java.lang.Class parentType)

Searches the parent hierarchy of the child for UIComponent of type parentType.

Parameters:

child - instance of UIComponent

parentType - Class of the parent UIComponent to be searched in the parent Hierarchy

Returns:

parent of type parentType

getParentByTypeAndId

public static javax.faces.component.UIComponent getParentByTypeAndId(javax.faces.component.UIComponent child,
                                                                     java.lang.Class parentType,
                                                                     java.lang.String id)

Searches the parent hierarchy of the child for UIComponent of type parentType and local id id.

Parameters:

child - instance of UIComponent.

parentType - Class of the parent UIComponent to be searched in the parent Hierarchy.

id - the local id of the component. DOes not take into account naming containers.

Returns:

parent of type parentType, null if not found.

invokePopup

public static void invokePopup(java.lang.String popupId)

Deprecated. As of ATGPF Drop5Prime, replaced by PatternsPublicUtil#invokePopup(String)

Invokes the specified popup.

Parameters:

popupId - id of the popup to be invoked

getAttribute

public static java.lang.String getAttribute(java.lang.String attrName,
                                            oracle.adf.view.rich.component.fragment.UIXDeclarativeComponent appsComponent)

Returns the attribute value of the attribute.

Parameters:

attrName - name of the attribute

appsComponent - UIXDeclarativeComponent containing the attribute.

Returns:

value of the attribute

getAttribute

public static java.lang.String getAttribute(java.lang.String attrName,
                                            oracle.adf.view.rich.component.fragment.UIXPageTemplate appsComponent)

Deprecated. replaced by #getAttribute(UIXDeclarativeComponent)

Returns the attribute value of the attribute.

Parameters:

attrName - name of the attribute

appsComponent - UIXPageTemplate containing the attribute.

Returns:

value of the attribute

getComponentAbsoluteId

public static java.lang.String getComponentAbsoluteId(oracle.adf.view.rich.component.fragment.UIXDeclarativeComponent appsComp,
                                                      java.lang.String componentId)

Returns the absolute id of the component.

Parameters:

appsComp - UIXDeclarativeComponent containing the component.

componentId - of the component

Returns:

absolute id of the component.

getAppsTableChildComponentAbsoluteId

public static java.lang.String getAppsTableChildComponentAbsoluteId(oracle.adf.view.rich.component.fragment.UIXDeclarativeComponent appsComp,
                                                                    java.lang.String componentId)

Returns the absolute id of the component inside the panelCollection of ApplicationsTable.

Parameters:

appsComp - UIXDeclarativeComponent containing the component.

componentId - of the component

Returns:

absolute id of the component.

getAppsTableChildComponentAbsoluteId

public static java.lang.String getAppsTableChildComponentAbsoluteId(oracle.adf.view.rich.component.fragment.UIXPageTemplate appsComp,
                                                                    java.lang.String componentId)

Deprecated. replaced by getAppsTableChildComponentAbsoluteId(UIXDeclarativeComponent, String)

getAppsTreeChildComponentAbsoluteId

public static java.lang.String getAppsTreeChildComponentAbsoluteId(oracle.adf.view.rich.component.fragment.UIXDeclarativeComponent appsComp,
                                                                   java.lang.String componentId)

Returns the absolute id of the component inside the panelCollection of ApplicationsTable.

Parameters:

appsComp - UIXDeclarativeComponent containing the component.

componentId - of the component

Returns:

absolute id of the component.

getAppsTreeChildComponentAbsoluteId

public static java.lang.String getAppsTreeChildComponentAbsoluteId(oracle.adf.view.rich.component.fragment.UIXPageTemplate appsComp,
                                                                   java.lang.String componentId)

Deprecated. replaced by getAppsTreeChildComponentAbsoluteId(UIXDeclarativeComponent, String)

getTasks

public static java.util.List<ItemNode> getTasks(org.apache.myfaces.trinidad.model.XMLMenuModel menuModel)

getFocusItemNode

public static ItemNode getFocusItemNode(org.apache.myfaces.trinidad.model.BaseMenuModel menuModel)

evaluateEL

public static java.lang.Object evaluateEL(java.lang.String el)

resolveParametersMap

public static java.util.Map resolveParametersMap(java.lang.String parametersMapEL,
                                                 java.lang.String parametersList)

Merge parameter definitions and return a unified Map.

Parameters:

parametersMapEL - EL that represents a java.util.Map.

parametersList - delimited name value pairs. e.g. "a=b;c=d" In addition, the value could be an EL. e.g. "a=b;c=#{SomeEL.someProperty}"

Returns:

a Map that contains the merged content of the two inputs

resolveKeyMap

public static java.util.Map resolveKeyMap(java.lang.String keyList,
                                          java.util.Map parametersMap)

Given parametersMap and list of key parameters, returns a new Map containing just the key-value pairs.

Parameters:

keyList - subset of keys of the parametersMap, or key-value pairs, delimited by semi-colon. For example, "param1;param2=value2".

parametersMap - original Map of parameters

Returns:

Map representing the key-value pairs specified in keyList, plus keys specified in keyList and the corresponding values in parametersMap.

isEditingUIShellTemplate

public static boolean isEditingUIShellTemplate(ApplSession applSession)

Determine whether the UIShell Template page is being edited.

Parameters:

applSession - current ApplSession instance

Returns:

true if the ModeContext is in edit mode and the page being edited is the UIShell Template Page.

isHistoryColumn

public static boolean isHistoryColumn(oracle.jbo.server.AttributeDefImpl attrDef)

Method for examining if an attribute is a history column

Parameters:

attrDef - Attribute Definition

Returns:

boolean value

isUniqueKeyColumn

public static boolean isUniqueKeyColumn(oracle.jbo.server.AttributeDefImpl attrDef)

Method for examining if an attribute is a unique key column

Parameters:

attrDef - Attribute Definition

Returns:

boolean value

isChangeIndicatorColumn

public static boolean isChangeIndicatorColumn(oracle.jbo.server.AttributeDefImpl attrDef)

Method for examining if an attribute is a unique key column

Parameters:

attrDef - Attribute Definition

Returns:

boolean value

setWindowTitle

public static void setWindowTitle(java.lang.String taskTitle)

setWindowTitle

public static void setWindowTitle(java.lang.String tasklabel,
                                  java.lang.String workAreaLabel)

constructPageParamsForNav

public static java.lang.String constructPageParamsForNav(java.lang.String pageParametersList)

getViewId

public static java.lang.String getViewId(org.apache.myfaces.trinidad.model.XMLMenuModel menuModel)

Get the View ID

Parameters:

menuModel -

Returns:

findComponentById

public static javax.faces.component.UIComponent findComponentById(javax.faces.component.UIComponent parent,
                                                                  java.lang.String id)

Find a component by ID when parent and searched component are passed.

Parameters:

parent - UIComponent Object

id - String value

Returns:

UIComponent Object

findNodeByPropertyValue

public static java.lang.Object findNodeByPropertyValue(org.apache.myfaces.trinidad.model.BaseMenuModel tree,
                                                       java.lang.String myVal,
                                                       java.lang.String myProp)

getDocumentRoot

public static java.lang.String getDocumentRoot()

getCurrentDistributedMenuModel

public static org.apache.myfaces.trinidad.model.BaseMenuModel getCurrentDistributedMenuModel(java.lang.String menuMode)

Get the most current Distributed Menu Model after checking security for the logged in user.

Parameters:

menuMode - It takes one of the three values: PatternsConstants.HOMEPAGE_MENU_MODEL for returning menu model for Home Page, PatternsConstants.NAVIGATOR_MENU_MODEL for returning menu model for Navigator, PatternsConstants.PREFERENCES_MENU_MODEL for returning menu model for Preferences.

Returns:

Distributed Menu Model

getWebAppName

public static java.lang.String getWebAppName(org.apache.myfaces.trinidad.model.XMLMenuModel menuModel)

Get the Web Application Name

Parameters:

menuModel -

Returns:

constructParamsForURL

public static java.lang.String constructParamsForURL(java.util.Map parametersMap)

constructParamStrFormMap

public static java.lang.String constructParamStrFormMap(java.util.Map parametersMap)

setHomePageWindowTitle

public static void setHomePageWindowTitle(java.lang.String taskTitle)

getPreferenceNode

public static SimpleMenuNode getPreferenceNode()

getActiveViewAppsMenuModel

public static ApplicationsMenuModel getActiveViewAppsMenuModel()

Gets the ApplicationsMenuModel for the current view

Returns:

ApplicationsMenuModel

getNonSecuredDistributedMenuModel

public static org.apache.myfaces.trinidad.model.BaseMenuModel getNonSecuredDistributedMenuModel(java.lang.String menuMode)

Get the most current Distributed Menu Model without checking security for the logged in user. This is for internal use only. Please do not use this API outside of ApplCore.

Parameters:

menuMode - It takes one of the three values: PatternsConstants.HOMEPAGE_MENU_MODEL for returning menu model for Home Page, PatternsConstants.NAVIGATOR_MENU_MODEL for returning menu model for Navigator, PatternsConstants.PREFERENCES_MENU_MODEL for returning menu model for Preferences.

Returns:

Distributed Menu Model

getCurrentUIShellWindowId

public static java.lang.String getCurrentUIShellWindowId()

launchSaveWarningPopup

public static void launchSaveWarningPopup(java.lang.String message)

evaluateELStringInParamList

public static java.lang.String evaluateELStringInParamList(java.lang.String elString)

This api takes parameterList separated by semicolon and then evaluates each parameter value if it starts with #. Returns parameterList back with all the evaluated parameter values.

Parameters:

elString -

Returns:

String parameterList back with all the evaluated parameter values.

isHomePage

public static boolean isHomePage()