Skip navigation links

Oracle Fusion Middleware Customizable Components Java API Reference for Oracle WebCenter
11g Release 1 (11.1.1)
E10692-01


oracle.adf.view.rich.component.customizable
Class ShowDetailFrame

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by org.apache.myfaces.trinidad.component.UIXComponent
          extended by org.apache.myfaces.trinidad.component.UIXComponentBase
              extended by org.apache.myfaces.trinidad.component.UIXShowDetail
                  extended by oracle.adf.view.core.component.customizable.ShowDetailFrame
                      extended by oracle.adf.view.rich.component.customizable.ShowDetailFrame

All Implemented Interfaces:
javax.faces.component.StateHolder

public class ShowDetailFrame
extends ShowDetailFrame

The ShowDetailFrame component wraps it's children in a border and provides several customization options for the wrapped content.

  Example: 
 
  <cust:showDetailFrame text="Show Detail Frame 1" >
    <af:objectImage source="graph.gif" />
  </cust:showDetailFrame>
  
  

Field Summary
static org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY
           
static java.lang.String COMPONENT_TYPE
           
static org.apache.myfaces.trinidad.bean.PropertyKey CUSTOM_ACTOINS_AVAILABLE_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey HELP_TOPIC_ID_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey IS_RTE_CHILD_KEY
           
static java.lang.String RENDERER_TYPE
           
static org.apache.myfaces.trinidad.bean.PropertyKey SELECT_CHILD_KEY
           
static java.lang.String SELECT_CHILD_NO
           
static java.lang.String SELECT_CHILD_YES
           
static java.lang.String SELECT_CHILD_ZOOM
           
static org.apache.myfaces.trinidad.bean.PropertyKey SHOW_EDIT_ACTION_KEY
           
static java.lang.String SHOW_REMOVE_ACTION_CHROME
           
static org.apache.myfaces.trinidad.bean.PropertyKey SHOW_REMOVE_ACTION_KEY
           
static java.lang.String SHOW_REMOVE_ACTION_NONE
           
static java.lang.String SHOW_RESIZER_ALWAYS
           
static org.apache.myfaces.trinidad.bean.PropertyKey SHOW_RESIZER_KEY
           
static java.lang.String SHOW_RESIZER_NEVER
           
static org.apache.myfaces.trinidad.bean.PropertyKey STRETCH_CONTENT_KEY
           
static org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
           

 

Fields inherited from class oracle.adf.view.core.component.customizable.ShowDetailFrame
BACKGROUND_DARK, BACKGROUND_KEY, BACKGROUND_LIGHT, BACKGROUND_MEDIUM, CLIENT_LISTENERS_KEY, COMPONENT_FAMILY, CONTAINS_IFRAME_KEY, CONTENT_INLINE_STYLE_KEY, CONTENT_STYLE_KEY, CUSTOMIZATION_ID_KEY, DISPLAY_ACTIONS_ALWAYS, DISPLAY_ACTIONS_KEY, DISPLAY_ACTIONS_ON_HOVER, DISPLAY_HEADER_KEY, DISPLAY_SHADOW_KEY, EXPANSION_MODE_MAXIMIZED, EXPANSION_MODE_MINIMIZED, EXPANSION_MODE_NORMAL, EXPANSIONMODE_KEY, ICON_KEY, INHERIT_GLOBAL_ACTIONS_KEY, INLINE_STYLE_KEY, IS_EDITABLE_KEY, IS_HELP_AVAILABLE_KEY, PARENT_PC_KEY, PARTIAL_TRIGGERS_KEY, ROOT_PARENT_KEY, SHORT_DESC_KEY, SHOW_MINIMIZE_ACTION_CHROME, SHOW_MINIMIZE_ACTION_KEY, SHOW_MINIMIZE_ACTION_NONE, SHOW_MOVE_ACTION_KEY, SHOW_MOVE_ACTION_MENU, SHOW_MOVE_ACTION_NONE, STYLE_CLASS_KEY, TEXT_KEY

 

Fields inherited from class org.apache.myfaces.trinidad.component.UIXShowDetail
DISCLOSED_KEY, DISCLOSED_TRANSIENT_KEY, DISCLOSURE_LISTENER_KEY, IMMEDIATE_KEY

 

Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

 

Fields inherited from class javax.faces.component.UIComponent
bindings

 

Constructor Summary
ShowDetailFrame()
          Constructs an instance of the ShowDetailFrame component.

 

Method Summary
 void broadcast(javax.faces.event.FacesEvent facesEvent)
          Handle disclosure, resize, delete events Other events are handled by core.ShowDetailFrame.
protected  java.util.List getActionsAvailable()
          Method to return actions allowed.
protected  org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
           
 java.util.Set getClientAttributes()
          Gets a set of client attribute names.
 java.lang.String getHelpTopicId()
          Attribute to hook up a help topic
 java.lang.String getSelectChild()
          get method for selectChild which indicates whether the child components are customizable.
 boolean getShowEditAction()
          Whether to show the edit action (pencil) or not
 java.lang.String getShowRemoveAction()
          Controls the display of remove action on the component.
 java.lang.String getShowResizer()
          Attribute to determine the rendering behaviour of SDF
 boolean getStretchContent()
          Attribute to determine whether to strech the child
 boolean isActionAllowed(java.lang.String action)
          Individual built-in actions are not secured by default.
 void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
          Restore state.
 java.lang.Object saveState(javax.faces.context.FacesContext context)
          Save state
 void setClientAttributes(java.util.Set clientAttributes)
          Sets a set of client attribute names.
 void setHelpTopicId(java.lang.String helpTopicId)
          Attribute to hook up a help topic
 void setSelectChild(java.lang.String selectChild)
          set method for selectChild which indicates whether the child components are customizable.
 void setShowEditAction(boolean showEditAction)
          sets whether the edit option should be rendered or not *
 void setShowRemoveAction(java.lang.String available)
          Controls display of remove action on the component.
 void setShowResizer(java.lang.String showResizer)
          Attribute to hook up one of the three possible showResizer value
 void setStretchContent(boolean stretchContent)
          Attribute to determine whether to strech the child.

 

Methods inherited from class oracle.adf.view.core.component.customizable.ShowDetailFrame
getBackground, getClientListeners, getContentInlineStyle, getContentStyle, getCustomizationId, getDisplayActions, getDisplayHeader, getDisplayShadow, getExpansionMode, getFamily, getIcon, getInheritGlobalActions, getInlineStyle, getShortDesc, getShowMinimizeAction, getShowMoveAction, getStyleClass, getText, setBackground, setClientListeners, setContentInlineStyle, setContentStyle, setCustomizationId, setDisplayActions, setDisplayHeader, setDisplayShadow, setExpansionMode, setIcon, setInheritGlobalActions, setInlineStyle, setShortDesc, setShowMinimizeAction, setShowMoveAction, setStyleClass, setText

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXShowDetail
addDisclosureListener, getDisclosureListener, getDisclosureListeners, isDisclosed, isDisclosedTransient, isImmediate, processDecodes, processUpdates, processValidators, queueEvent, removeDisclosureListener, setDisclosed, setDisclosedTransient, setDisclosureListener, setDisclosureListener, setImmediate

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, removeAttributeChangeListener, removeFacesListener, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent
addPartialTarget, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree, visitTree

 

Methods inherited from class javax.faces.component.UIComponent
getContainerClientId

 

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

 

Field Detail

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

SELECT_CHILD_YES

public static final java.lang.String SELECT_CHILD_YES
See Also:
Constant Field Values

SELECT_CHILD_NO

public static final java.lang.String SELECT_CHILD_NO
See Also:
Constant Field Values

SELECT_CHILD_ZOOM

public static final java.lang.String SELECT_CHILD_ZOOM
See Also:
Constant Field Values

SHOW_RESIZER_NEVER

public static final java.lang.String SHOW_RESIZER_NEVER
See Also:
Constant Field Values

SHOW_RESIZER_ALWAYS

public static final java.lang.String SHOW_RESIZER_ALWAYS
See Also:
Constant Field Values

SHOW_REMOVE_ACTION_NONE

public static final java.lang.String SHOW_REMOVE_ACTION_NONE
See Also:
Constant Field Values

SHOW_REMOVE_ACTION_CHROME

public static final java.lang.String SHOW_REMOVE_ACTION_CHROME
See Also:
Constant Field Values

SHOW_REMOVE_ACTION_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHOW_REMOVE_ACTION_KEY

HELP_TOPIC_ID_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey HELP_TOPIC_ID_KEY

STRETCH_CONTENT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey STRETCH_CONTENT_KEY

SHOW_RESIZER_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHOW_RESIZER_KEY

SELECT_CHILD_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SELECT_CHILD_KEY

CLIENT_ATTRIBUTES_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY

IS_RTE_CHILD_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey IS_RTE_CHILD_KEY

SHOW_EDIT_ACTION_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHOW_EDIT_ACTION_KEY

CUSTOM_ACTOINS_AVAILABLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOM_ACTOINS_AVAILABLE_KEY

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE
See Also:
Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values

Constructor Detail

ShowDetailFrame

public ShowDetailFrame()
Constructs an instance of the ShowDetailFrame component.

Method Detail

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
Overrides:
getBeanType in class ShowDetailFrame

getShowRemoveAction

public java.lang.String getShowRemoveAction()
Controls the display of remove action on the component. If set to false, remove action will not be available on the component.
Returns:
the current value of showRemoveAction attribute

setShowRemoveAction

public void setShowRemoveAction(java.lang.String available)
Controls display of remove action on the component. If set to false, remove action will not be available on the component.
Parameters:
available - new value of the attribute

getHelpTopicId

public java.lang.String getHelpTopicId()
Attribute to hook up a help topic
Returns:
the current value of helpTopicId attribute

setHelpTopicId

public void setHelpTopicId(java.lang.String helpTopicId)
Attribute to hook up a help topic
Parameters:
helpTopicId - new value of the attribute

getStretchContent

public boolean getStretchContent()
Attribute to determine whether to strech the child
Returns:
the current value of stretchContent attribute

setStretchContent

public void setStretchContent(boolean stretchContent)
Attribute to determine whether to strech the child.
Parameters:
stretchContent - new value of the attribute

getShowResizer

public java.lang.String getShowResizer()
Attribute to determine the rendering behaviour of SDF
Returns:
the current value of showResizer attribute

setShowResizer

public void setShowResizer(java.lang.String showResizer)
Attribute to hook up one of the three possible showResizer value
Parameters:
showResizer - new value of the attribute

getClientAttributes

public final java.util.Set getClientAttributes()
Gets a set of client attribute names.
Returns:
the new clientAttributes value

setClientAttributes

public final void setClientAttributes(java.util.Set clientAttributes)
Sets a set of client attribute names.
Parameters:
clientAttributes - the new clientAttributes value

getSelectChild

public java.lang.String getSelectChild()
get method for selectChild which indicates whether the child components are customizable. When set to no, child components can not be customized at Runtime.
Returns:
value of the selectChild attribute

setSelectChild

public void setSelectChild(java.lang.String selectChild)
set method for selectChild which indicates whether the child components are customizable. When set to no, child components can not be customized at Runtime.
Parameters:
selectChild - value of the selectChild attribute

setShowEditAction

public void setShowEditAction(boolean showEditAction)
sets whether the edit option should be rendered or not *
Parameters:
showEdit - whether to show or hide edit action

getShowEditAction

public boolean getShowEditAction()
Whether to show the edit action (pencil) or not
Returns:
Whether to show the edit option (pencil) or not

broadcast

public void broadcast(javax.faces.event.FacesEvent facesEvent)
               throws javax.faces.event.AbortProcessingException
Handle disclosure, resize, delete events Other events are handled by core.ShowDetailFrame.
Overrides:
broadcast in class ShowDetailFrame
Parameters:
facesEvent - the facesEvent object
Throws:
javax.faces.event.AbortProcessingException

isActionAllowed

public final boolean isActionAllowed(java.lang.String action)
Individual built-in actions are not secured by default. The ability to customize a component as a whole is inherited from the page permissions. If more granular activities within a component are required, then the page-level security inheritance and security on required actions should be over-ridden.

The ability of a user to perform actions on components is inherited from the page security based on the value of the application-wide switch, enableSecurity, in the adf-config.xml file.

<cust:customizableComponentsSecurity xmlns:cust="http://xmlns.oracle.com/adf/faces/customizable/config">
<cust:enableSecurity value="true"/>
<cust:actionsCategory>
..........................................
</cust:actionsCategory>
</cust:customizableComponentsSecurity>

Security for actions on components can be implemented at the following levels:

Checks the following to decide if action can be allowed: 1. If customization ID is set 2. Based on user privileges/global action configurations decide if action can be allowed 3. Check if the component has MDS restriction.
Parameters:
action -
Returns:
true if action is allowed else false

getActionsAvailable

protected java.util.List getActionsAvailable()
Method to return actions allowed. This is needed for Portlet.

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)
Save state
Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class org.apache.myfaces.trinidad.component.UIXComponentBase
Parameters:
context -
Returns:

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object state)
Restore state.
Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class org.apache.myfaces.trinidad.component.UIXComponentBase
Parameters:
context -
state -

Skip navigation links

Oracle Fusion Middleware Customizable Components Java API Reference for Oracle WebCenter
11g Release 1 (11.1.1)
E10692-01


Copyright © 2005, 2009, Oracle. All rights reserved.