|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal 11g Release 1 (11.1.1.9.0) E15995-08 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
public class 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, defaultGetRenderedFacetsAndChildren, 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 |
---|
public static final java.lang.String ALLOW_ACTION_ALL
public static final java.lang.String ALLOW_ACTION_NONE
public static final java.lang.String HALIGN_START
public static final java.lang.String HALIGN_CENTER
public static final java.lang.String HALIGN_END
public static final java.lang.String HALIGN_LEFT
public static final java.lang.String HALIGN_RIGHT
public static final java.lang.String VALIGN_TOP
public static final java.lang.String VALIGN_MIDDLE
public static final java.lang.String VALIGN_BOTTOM
public static final java.lang.String VALIGN_BASELINE
public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
public static final org.apache.myfaces.trinidad.bean.PropertyKey ALLOW_ACTION_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SHOW_EDIT_ACTION_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SHOW_ADD_CONTENT_ACTION_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SHOW_SPLIT_ACTION_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SHOW_TAB_ACTION_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey HALIGN_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey VALIGN_KEY
public static final java.lang.String RENDERER_TYPE
public static final java.lang.String COMPONENT_TYPE
public static final java.lang.String LAYOUT_STRETCH
public static final java.lang.String LAYOUT_AUTO
Constructor Detail |
---|
public PanelCustomizable()
Method Detail |
---|
public final java.lang.String getAllowAction()
public final boolean isActionAllowed(java.lang.String action)
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.
action
-public java.lang.Object saveState(javax.faces.context.FacesContext context)
saveState
in interface javax.faces.component.StateHolder
saveState
in class org.apache.myfaces.trinidad.component.UIXComponentBase
context
-public void broadcast(javax.faces.event.FacesEvent facesEvent) throws javax.faces.event.AbortProcessingException
broadcast
in class org.apache.myfaces.trinidad.component.UIXComponentBase
facesEvent
- the facesEvent objectjavax.faces.event.AbortProcessingException
public boolean canDelete(javax.faces.context.FacesContext context)
public void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class org.apache.myfaces.trinidad.component.UIXComponentBase
context
-state
-public final void setAllowAction(java.lang.String allowAction)
allowAction
- new value of attributepublic final java.util.Set getClientAttributes()
public final void setClientAttributes(java.util.Set clientAttributes)
clientAttributes
- the new clientAttributes valuepublic void setShowEditAction(boolean showEditAction)
showEditAction
- whether to show or hide edit actionpublic boolean getShowEditAction()
public void setShowSplitAction(boolean showSplitAction)
showSplitAction
- whether to show or hide edit actionpublic boolean getShowSplitAction()
public void setShowTabAction(boolean showTabAction)
showTabAction
- whether to show or hide add tab actionpublic boolean getShowTabAction()
public java.lang.String getHalign()
public void setHalign(java.lang.String halign)
halign
- one of the HALIGN_ constantspublic java.lang.String getValign()
public void setValign(java.lang.String valign)
valign
- one of the VALIGN_ constantsprotected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
PanelCustomizable
getBeanType
in class PanelCustomizable
|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal 11g Release 1 (11.1.1.9.0) E15995-08 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |