Skip navigation links

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

java.lang.Object
javax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
org.apache.myfaces.trinidad.component.UIXPanel
oracle.adf.view.core.component.customizable.PanelCustomizable
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	HALIGN_CENTER
static java.lang.String	HALIGN_END
static org.apache.myfaces.trinidad.bean.PropertyKey	HALIGN_KEY
static java.lang.String	HALIGN_LEFT
static java.lang.String	HALIGN_RIGHT
static java.lang.String	HALIGN_START
static java.lang.String	LAYOUT_AUTO
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.PropertyKey	SHOW_SPLIT_ACTION_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHOW_TAB_ACTION_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE
static java.lang.String	VALIGN_BASELINE
static java.lang.String	VALIGN_BOTTOM
static org.apache.myfaces.trinidad.bean.PropertyKey	VALIGN_KEY
static java.lang.String	VALIGN_MIDDLE
static java.lang.String	VALIGN_TOP

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.
java.lang.String	getHalign() Returns the horizontal alignment of this component.
boolean	getShowEditAction() Whether to show the edit action (pencil) or not
boolean	getShowSplitAction() Whether to show the split action or not
boolean	getShowTabAction() Whether to show the add tab action or not
java.lang.String	getValign() Returns the vertical alignment of this component.
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	setHalign(java.lang.String halign) Sets the horizontal alignment of the component.
void	setShowEditAction(boolean showEditAction) sets whether the edit option should be rendered or not
void	setShowSplitAction(boolean showSplitAction) sets whether the split option should be rendered or not
void	setShowTabAction(boolean showTabAction) sets whether the add tab option should be rendered or not
void	setValign(java.lang.String valign) Sets the vertical alignment of the component.

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, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getComponentChangeFilters, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeAttributeChangeListener, removeComponentChangeFilter, removeFacesListener, satisfiesPartialTrigger, 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, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll, 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

HALIGN_START

public static final java.lang.String HALIGN_START

See Also:

Constant Field Values

HALIGN_CENTER

public static final java.lang.String HALIGN_CENTER

See Also:

Constant Field Values

HALIGN_END

public static final java.lang.String HALIGN_END

See Also:

Constant Field Values

HALIGN_LEFT

public static final java.lang.String HALIGN_LEFT

See Also:

Constant Field Values

HALIGN_RIGHT

public static final java.lang.String HALIGN_RIGHT

See Also:

Constant Field Values

VALIGN_TOP

public static final java.lang.String VALIGN_TOP

See Also:

Constant Field Values

VALIGN_MIDDLE

public static final java.lang.String VALIGN_MIDDLE

See Also:

Constant Field Values

VALIGN_BOTTOM

public static final java.lang.String VALIGN_BOTTOM

See Also:

Constant Field Values

VALIGN_BASELINE

public static final java.lang.String VALIGN_BASELINE

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

SHOW_SPLIT_ACTION_KEY

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

SHOW_TAB_ACTION_KEY

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

HALIGN_KEY

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

VALIGN_KEY

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

LAYOUT_AUTO

public static final java.lang.String LAYOUT_AUTO

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:

• Page level: You can define security for portlets and customizable components such that page-level privileges are inherited by these components. This is the default behavior.

  By default, portlets and customizable components inherit allowable actions from the defined page-level permissions such as personalize or customize. That is, a user who has customize privileges on the page has permission on the customize action for the components on that page. The enableSecurity element enables you to override the security inheritance behavior and can take either of the following values:

  • true: If set to true (the default), then the ability for a user to modify a component will first be determined from the page permissions and then adjusted according to the current set of actions defined for that type of permission. If a user has customize permission, then the actions that constitute the customize category (move, customize, and so on) are available to the user, but they will be overridden by the actions that are defined in the adf-config.xml file. For example, a page designer wants to allow the end user to be able to customize portlets, but not customize the page layout. By setting enableSecurity to true, the page designer enforces that users must first have customize permission on the page. Setting customizeActionsCategory to false for customizable components will prevent the customization of the page layout, yet still allowing portlet customization. (As the default for customizeActionsCategory is true, it does not need to be set explicitly for portlets.).

  • false: If set to false, then the behavior is to ignore the user's page permissions and base the available actions on the manually specified list in the adf-config.xml file. In this case, the actions are global and available to all users. That is, the default page privileges (View, Personalize, and Customize for portlets and View and Customize for customizable components) are available for all portlets and customizable components.

• Actions category level: You can define security on all actions for portlets or customizable components that belong to a named category.

  You can add an actionsCategory element in the adf-config.xml file to define security on multiple actions simultaneously. Depending on the actionCategory attributes that you enable, appropriate privileges are provided on the portlets or customizable components.

• Actions level: You can define security on individual actions for portlets or customizable components.

  You can use the actions element in the adf-config.xml file to enable or disable individual actions. Depending on the actions attributes that you enable, appropriate privileges are provided on the portlets or customizable components.

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:

showEditAction - 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

setShowSplitAction

public void setShowSplitAction(boolean showSplitAction)

sets whether the split option should be rendered or not

Parameters:

showSplitAction - whether to show or hide edit action

getShowSplitAction

public boolean getShowSplitAction()

Whether to show the split action or not

Returns:

Whether to show the edit option or not

setShowTabAction

public void setShowTabAction(boolean showTabAction)

sets whether the add tab option should be rendered or not

Parameters:

showTabAction - whether to show or hide add tab action

getShowTabAction

public boolean getShowTabAction()

Whether to show the add tab action or not

Returns:

Whether to show the add tab action or not

getHalign

public java.lang.String getHalign()

Returns the horizontal alignment of this component.

Returns:

the current value of the halign attribute.

setHalign

public void setHalign(java.lang.String halign)

Sets the horizontal alignment of the component.

Parameters:

halign - one of the HALIGN_ constants

getValign

public java.lang.String getValign()

Returns the vertical alignment of this component.

Returns:

the current value of the valign attribute.

setValign

public void setValign(java.lang.String valign)

Sets the vertical alignment of the component.

Parameters:

valign - one of the VALIGN_ constants

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()

Description copied from class: PanelCustomizable

Overrides:

getBeanType in class PanelCustomizable

Skip navigation links