|
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.UIXShowDetail
oracle.adf.view.core.component.customizable.ShowDetailFrame
oracle.adf.view.rich.component.customizable.ShowDetailFrame
public class 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 java.lang.String |
CHILD_CREATION_IMMEDIATE |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CHILD_CREATION_KEY |
static java.lang.String |
CHILD_CREATION_LAZY |
static java.lang.String |
CHILD_CREATION_LAZY_UNCACHED |
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 java.lang.String |
STRETCH_CONTENT_AUTO |
static java.lang.String |
STRETCH_CONTENT_FALSE |
static org.apache.myfaces.trinidad.bean.PropertyKey |
STRETCH_CONTENT_KEY |
static java.lang.String |
STRETCH_CONTENT_TRUE |
static org.apache.myfaces.trinidad.bean.FacesBean.Type |
TYPE |
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.lang.String |
getChildCreation() Gets Controls when the children components are created. |
java.util.Set |
getClientAttributes() Gets a set of client attribute names. |
java.lang.String |
getExpansionMode() Gets the expansionMode of the component. |
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() Deprecated. use getStretchContent2() Attribute to determine whether to strech the child |
java.lang.String |
getStretchContent2() Attribute to determine whether to strech the child |
boolean |
isActionAllowed(java.lang.String action) Individual built-in actions are not secured by default. |
boolean |
isRendered() Determines if the ShowDetailFrame can be rendered. |
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 |
setChildCreation(java.lang.String childCreation) Sets Controls when the children components are created. |
void |
setClientAttributes(java.util.Set clientAttributes) Sets a set of client attribute names. |
void |
setExpansionMode(java.lang.String expansionMode) Sets the expansionMode of the component. |
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) Deprecated. Use setStretchContent(String) Attribute to determine whether to strech the child. |
void |
setStretchContent(java.lang.String stretchContent) Attribute to determine whether to strech the child. |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXShowDetail |
---|
addDisclosureListener, getDisclosureListener, getDisclosureListeners, getRenderedFacetsAndChildren, isDisclosed, isDisclosedTransient, isImmediate, queueEvent, removeDisclosureListener, setDisclosed, setDisclosedTransient, setDisclosureListener, setDisclosureListener, setImmediate |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase |
---|
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, 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, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isTransient, markInitialState, processRestoreState, processSaveState, 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 org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
public static final java.lang.String SELECT_CHILD_YES
public static final java.lang.String SELECT_CHILD_NO
public static final java.lang.String SELECT_CHILD_ZOOM
public static final java.lang.String SHOW_RESIZER_NEVER
public static final java.lang.String SHOW_RESIZER_ALWAYS
public static final java.lang.String SHOW_REMOVE_ACTION_NONE
public static final java.lang.String SHOW_REMOVE_ACTION_CHROME
public static final java.lang.String STRETCH_CONTENT_AUTO
public static final java.lang.String STRETCH_CONTENT_TRUE
public static final java.lang.String STRETCH_CONTENT_FALSE
public static final java.lang.String CHILD_CREATION_IMMEDIATE
public static final java.lang.String CHILD_CREATION_LAZY
public static final java.lang.String CHILD_CREATION_LAZY_UNCACHED
public static final org.apache.myfaces.trinidad.bean.PropertyKey SHOW_REMOVE_ACTION_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey HELP_TOPIC_ID_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey STRETCH_CONTENT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SHOW_RESIZER_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SELECT_CHILD_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey IS_RTE_CHILD_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SHOW_EDIT_ACTION_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOM_ACTOINS_AVAILABLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CHILD_CREATION_KEY
public static final java.lang.String RENDERER_TYPE
public static final java.lang.String COMPONENT_TYPE
Constructor Detail |
---|
public ShowDetailFrame()
Method Detail |
---|
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
getBeanType
in class ShowDetailFrame
public java.lang.String getShowRemoveAction()
public void setShowRemoveAction(java.lang.String available)
available
- new value of the attributepublic java.lang.String getHelpTopicId()
public void setHelpTopicId(java.lang.String helpTopicId)
helpTopicId
- new value of the attributepublic boolean getStretchContent()
getStretchContent2()
Attribute to determine whether to strech the childpublic java.lang.String getStretchContent2()
public void setStretchContent(boolean stretchContent)
setStretchContent(String)
Attribute to determine whether to strech the child.stretchContent
- new value of the attributepublic void setStretchContent(java.lang.String stretchContent)
stretchContent
- new value of the attributepublic java.lang.String getShowResizer()
public void setShowResizer(java.lang.String showResizer)
showResizer
- new value of the attributepublic final java.util.Set getClientAttributes()
public final void setClientAttributes(java.util.Set clientAttributes)
clientAttributes
- the new clientAttributes valuepublic java.lang.String getSelectChild()
public void setSelectChild(java.lang.String selectChild)
selectChild
- value of the selectChild attributepublic void setShowEditAction(boolean showEditAction)
showEditAction
- whether to show or hide edit actionpublic boolean getShowEditAction()
public void broadcast(javax.faces.event.FacesEvent facesEvent) throws javax.faces.event.AbortProcessingException
broadcast
in class ShowDetailFrame
facesEvent
- the facesEvent objectjavax.faces.event.AbortProcessingException
public java.lang.String getExpansionMode()
getExpansionMode
in class ShowDetailFrame
public void setExpansionMode(java.lang.String expansionMode)
setExpansionMode
in class ShowDetailFrame
expansionMode
- the new expansion mode - an be maximized, minimized, or restore.getExpansionMode()
public final java.lang.String getChildCreation()
The non-immediate settings will only work when the children components are created via the UIXComponentELTag and are not in a stamping component (like af:iterator).
Legal values are:public final void setChildCreation(java.lang.String childCreation)
The non-immediate settings will only work when the children components are created via the UIXComponentELTag and are not in a stamping component (like af:iterator).
Legal values are:childCreation
- the new childCreation valuepublic 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
-protected java.util.List getActionsAvailable()
public boolean isRendered()
ShowDetailFrame does not render if the enclosed RichRegion
is not provisioned with 'view' priviledge. If however, the child component is not a RichRegion
, the ShowDetailFrame renderes provided the rendered
evaluates to true
.
Note: The ShowDetailFrame renderes if the child component is RichRegion
and the Task Flow metadata cannot be derived.
isRendered
in class org.apache.myfaces.trinidad.component.UIXComponentBase
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 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
-
|
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 |