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 PanelCustomizable

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.UIXPanel
                  extended by oracle.adf.view.core.component.customizable.PanelCustomizable
                      extended by oracle.adf.view.rich.component.customizable.PanelCustomizable

All Implemented Interfaces:
javax.faces.component.StateHolder

public class PanelCustomizable
extends PanelCustomizable

PanelCustomizable is a layout component that wraps its children in one of two ways - either horizontal or vertical. In addition, if the children are ShowDetailFrame components, then the children ShowDetailFrame components can also be moved around within this component.

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

In this example, you can move the showDetailFrame 1 and 2 up and down.

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

In this example, you can move the showDetailFrame children horizontally.


Field Summary
static java.lang.String ALLOW_ACTION_ALL
           
static org.apache.myfaces.trinidad.bean.PropertyKey ALLOW_ACTION_KEY
           
static java.lang.String ALLOW_ACTION_NONE
           
static org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY
           
static java.lang.String COMPONENT_TYPE
           
static java.lang.String LAYOUT_STRETCH
           
static java.lang.String RENDERER_TYPE
           
static org.apache.myfaces.trinidad.bean.PropertyKey SHOW_ADD_CONTENT_ACTION_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey SHOW_EDIT_ACTION_KEY
           
static org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
           

 

Fields inherited from class oracle.adf.view.core.component.customizable.PanelCustomizable
CLIENT_LISTENERS_KEY, COMPONENT_FAMILY, CUSTOMIZATION_ID_KEY, HEIGHT_KEY, INLINE_STYLE_KEY, LAYOUT_HORIZONTAL, LAYOUT_KEY, LAYOUT_SCROLL, LAYOUT_VERTICAL, PARTIAL_TRIGGERS_KEY, SEPARATOR_FACET, SHORT_DESC_KEY, STYLE_CLASS_KEY, WIDTH_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
PanelCustomizable()
          Constructs an instance of the PanelCustomizable component.

 

Method Summary
 void broadcast(javax.faces.event.FacesEvent facesEvent)
          Processes drag and drop resource event, else calls the default UIComponent.broadcast(facesEvent)
 boolean canDelete(javax.faces.context.FacesContext context)
          Return whether the component is deletable.
 java.lang.String getAllowAction()
          Deprecated. Instead use isActionAllowed.
protected  org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
          
 java.util.Set getClientAttributes()
          Gets a set of client attribute names.
 boolean getShowEditAction()
          Whether to show the edit action (pencil) or not
 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 setAllowAction(java.lang.String allowAction)
          Sets the allowAction attribute value of the component.
 void setClientAttributes(java.util.Set clientAttributes)
          Sets a set of client attribute names.
 void setShowEditAction(boolean showEditAction)
          sets whether the edit option should be rendered or not

 

Methods inherited from class oracle.adf.view.core.component.customizable.PanelCustomizable
decode, getClientListeners, getCustomizationId, getFamily, getHeight, getInlineStyle, getLayout, getShortDesc, getStyleClass, getWidth, setClientListeners, setCustomizationId, setHeight, setInlineStyle, setLayout, setShortDesc, setStyleClass, setWidth

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, 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, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, 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

ALLOW_ACTION_ALL

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

ALLOW_ACTION_NONE

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

TYPE

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

ALLOW_ACTION_KEY

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

CLIENT_ATTRIBUTES_KEY

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

SHOW_EDIT_ACTION_KEY

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

SHOW_ADD_CONTENT_ACTION_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHOW_ADD_CONTENT_ACTION_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

LAYOUT_STRETCH

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

Constructor Detail

PanelCustomizable

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

Method Detail

getAllowAction

public final java.lang.String getAllowAction()
Deprecated. Instead use isActionAllowed.
Returns the allowAction attribute value of the component.
Returns:
value of allowAction property

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. If individual action is set to none. 3. Based on user privileges/global action configurations decide if action can be allowed 4. Check if the component has MDS restriction.
Parameters:
action -
Returns:
true if action is allowed else false

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:

broadcast

public void broadcast(javax.faces.event.FacesEvent facesEvent)
               throws javax.faces.event.AbortProcessingException
Processes drag and drop resource event, else calls the default UIComponent.broadcast(facesEvent)
Overrides:
broadcast in class org.apache.myfaces.trinidad.component.UIXComponentBase
Parameters:
facesEvent - the facesEvent object
Throws:
javax.faces.event.AbortProcessingException

canDelete

public boolean canDelete(javax.faces.context.FacesContext context)
Return whether the component is deletable.

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 -

setAllowAction

public final void setAllowAction(java.lang.String allowAction)
Sets the allowAction attribute value of the component.
Parameters:
allowAction - new value of 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

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

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
Description copied from class: PanelCustomizable
Overrides:
getBeanType in class PanelCustomizable

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.