Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle WebCenter
11g Release 1 (11.1.1.4.0)
E15995-03


oracle.adf.view.rich.component.portlet
Class PortletBase

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
                          extended by oracle.adf.view.rich.component.portlet.PortletBase

All Implemented Interfaces:
javax.faces.component.ActionSource, javax.faces.component.StateHolder, PortletComponent, oracle.adf.view.core.component.portlet.PortletComponentBehaviour, oracle.portlet.client.utils.debug.DebugHelper

public class PortletBase
extends ShowDetailFrame
implements PortletComponent, javax.faces.component.ActionSource, oracle.adf.view.core.component.portlet.PortletComponentBehaviour, oracle.portlet.client.utils.debug.DebugHelper

PortletBase is an ADF Faces JSF view componenet class for rendering Oracle JDPK and WSRP Portlets.

The PortletBase UIComponent extends the ShowDetailFrame and the default renderer for this component uses the ShowDetailFrameRenderer to render the decoration around the portlet.

This Rich Portlet Component is designed to be rendered by a renderer that is compatible with ADF Faces RichClient components.


Field Summary
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
static java.lang.String RENDERER_TYPE
           
static org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
           

 

Fields inherited from class oracle.adf.view.rich.component.customizable.ShowDetailFrame
CLIENT_ATTRIBUTES_KEY, CUSTOM_ACTOINS_AVAILABLE_KEY, HELP_TOPIC_ID_KEY, IS_RTE_CHILD_KEY, SELECT_CHILD_KEY, SELECT_CHILD_NO, SELECT_CHILD_YES, SELECT_CHILD_ZOOM, SHOW_EDIT_ACTION_KEY, SHOW_REMOVE_ACTION_CHROME, SHOW_REMOVE_ACTION_KEY, SHOW_REMOVE_ACTION_NONE, SHOW_RESIZER_ALWAYS, SHOW_RESIZER_KEY, SHOW_RESIZER_NEVER, STRETCH_CONTENT_AUTO, STRETCH_CONTENT_FALSE, STRETCH_CONTENT_KEY, STRETCH_CONTENT_TRUE

 

Fields inherited from class oracle.adf.view.core.component.customizable.ShowDetailFrame
BACKGROUND_DARK, BACKGROUND_KEY, BACKGROUND_LIGHT, BACKGROUND_MEDIUM, CLIENT_LISTENERS_KEY, 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, HEADER_STYLE_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

 

Fields inherited from interface oracle.adf.view.core.component.portlet.PortletComponent
PORTLET_MODE_CHANGE

 

Constructor Summary
PortletBase()
           

 

Method Summary
 void addActionListener(javax.faces.event.ActionListener listener)
           
 void applyPortletModeChange(int newMode)
          Set a new mode on the Portlet to which this component is bound.
 void applyPortletWindowStateChange(int newWindowState)
          Set a new WindowState on the Portlet to which this component is bound.
 void broadcast(javax.faces.event.FacesEvent facesEvent)
          Handle disclosure, resize, delete events Other events are handled by core.ShowDetailFrame.
 javax.faces.el.MethodBinding getAction()
           
 javax.faces.el.MethodBinding getActionListener()
           
 javax.faces.event.ActionListener[] getActionListeners()
           
 java.lang.String getAllModesSharedScreen()
           
protected  org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
           
 java.util.List getCachedActionsAvailable()
          Public wrapper to get the getActionsAvailable method on the ShowDetailFrame.
 java.lang.String getDebugValue()
           
 boolean getDisplayScrollBar()
           
 java.lang.String getFamily()
          Returns the component family.
 java.lang.String getHeight()
           
 java.lang.String getIframeDtd()
           
 boolean getIsAboutModeAvailable()
           
 boolean getIsConfigModeAvailable()
           
 boolean getIsCustomizeModeAvailable()
           
 boolean getIsDetailModeAvailable()
           
 boolean getIsHelpModeAvailable()
           
 boolean getIsNormalModeAvailable()
           
 boolean getIsPersonalizeModeAvailable()
           
 boolean getIsPreviewModeAvailable()
           
 boolean getIsPrintModeAvailable()
           
 java.lang.String[] getPartialTriggers()
           
 oracle.adf.model.portlet.binding.PortletBinding getPortletBinding()
          Deprecated. Interact with the PortletModel directly.
 oracle.adf.model.portlet.binding.PortletModel getPortletModel()
          Helper method to get the PortletModel.
 java.lang.String getRendererType()
          Returns the renderer type for this component.
 java.lang.String getRenderPortletInIFrame()
           
 boolean getSubmitUrlParameters()
           
 java.lang.String getText()
          Returns the title of the component in String form.
 java.lang.String getTitle()
          Get the title set on the Portlet, if any.
 java.lang.Object getValue()
          Get the Portlet Binding object on this component.
 java.lang.String getWidth()
           
 void handleDataDirtyEvent(oracle.adf.view.rich.render.ClientEvent clientEvent)
          Handle dataDirty status carrying events sent to pass the data dirty status from PPR (resource request) in the client to the server.
 void handlePartialAdfmEvent(oracle.adf.view.rich.render.ClientEvent clientEvent)
          Handle ADFm events propagated raised by a bridge portlet and encoded as a ClientEvent.
 boolean isRendered()
          Determines if the ShowDetailFrame can be rendered.
 void removeActionListener(javax.faces.event.ActionListener listener)
           
 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 setAction(javax.faces.el.MethodBinding mb)
           
 void setActionListener(javax.faces.el.MethodBinding mb)
           
 void setAllModesSharedScreen(java.lang.String allModesSharedScreen)
          The allModesSharedScreen setting on the component determines whether non-show modes (modes other than View for JSR168 or Show for JPDK) render inline within the portlet or on a new page.
 void setDisplayScrollBar(boolean displayScrollBar)
          The displayScrollBar property determines whether scroll bars for scrolling the content of the Portlet are displayed.
 void setErrorMessage(javax.faces.application.FacesMessage.Severity severity, java.lang.Throwable error)
          Stores an error state on the portlet component.
 void setHeight(java.lang.String height)
          The height property will determines the height of the portlet on the page.
 void setIframeDtd(java.lang.String iframeDtd)
          The iframeDtd attribute controls which HTML dtd is used in the doctype declation for the iframe content document when the Portlet is rendered in an iframe.
 void setIsAboutModeAvailable(boolean isAboutModeAvailable)
          The isAboutModeAvailable property determines whether the Portlet view component allows the Portlet's About mode to be shown.
 void setIsConfigModeAvailable(boolean isConfigModeAvailable)
          The isConfigModeAvailable property determines whether the Portlet view component allows the Portlet's Config mode to be shown.
 void setIsCustomizeModeAvailable(boolean isCustomizeModeAvailable)
          The isCustomizeModeAvailable property determines whether the Portlet view component allows the Portlet's Customize mode to be shown.
 void setIsDetailModeAvailable(boolean isDetailModeAvailable)
          The isDetailModeAvailable property determines whether the Portlet view component allows the Portlet's Detail mode to be shown.
 void setIsHelpModeAvailable(boolean isHelpModeAvailable)
          The isHelpModeAvailable property determines whether the Portlet view component allows the Portlet's Help mode to be shown.
 void setIsNormalModeAvailable(boolean isNormalModeAvailable)
          Is the isNormalModeAvailable is a boolean property that determines whether Refresh is show in the Portlet actions menu.
 void setIsPersonalizeModeAvailable(boolean isPersonalizeModeAvailable)
          The isPersonalizeModeAvailable property determines whether the Portlet view component allows the Portlet's Personalize mode to be shown.
 void setIsPreviewModeAvailable(boolean isPreviewModeAvailable)
          The isPreviewModeAvailable property determines whether the Portlet view component allows the Portlet's Preview mode to be shown.
 void setIsPrintModeAvailable(boolean isPrintModeAvailable)
          The isPrintModeAvailable property determines whether the Portlet view component allows the Portlet's Print mode to be shown.
 void setPartialTriggers(java.lang.String[] partialTriggers)
          Set String array for the partialTriggers for portlet component.
 void setRenderPortletInIFrame(java.lang.String renderPortletInIFrame)
          The renderPortletInIFrame property determines whether the Portlet view component should show the Portlet markup content inside an iFrame.
 void setSubmitUrlParameters(boolean submitUrlParameters)
          When a link in a Portlet is clicked and that link points to the page on which the Portlet resides, the submitUrlParameter property determines whether the parameters in the link are available to the containing page or only sent back to the Portlet.
 void setTitle(java.lang.String title)
          Set the title property for this portlet component.
 void setValue(java.lang.Object value)
          The value property holds the PortletBinding object that this view component uses to interact with the real remote Portlet.
 void setWidth(java.lang.String width)
          The width property will determines the width of the portlet on the page.

 

Methods inherited from class oracle.adf.view.rich.component.customizable.ShowDetailFrame
getActionsAvailable, getClientAttributes, getHelpTopicId, getSelectChild, getShowEditAction, getShowRemoveAction, getShowResizer, getStretchContent, getStretchContent2, isActionAllowed, setClientAttributes, setHelpTopicId, setSelectChild, setShowEditAction, setShowRemoveAction, setShowResizer, setStretchContent, setStretchContent

 

Methods inherited from class oracle.adf.view.core.component.customizable.ShowDetailFrame
getBackground, getClientListeners, getContentInlineStyle, getContentStyle, getCustomizationId, getDisplayActions, getDisplayHeader, getDisplayShadow, getExpansionMode, getHeaderStyle, getIcon, getInheritGlobalActions, getInlineStyle, getShortDesc, getShowMinimizeAction, getShowMoveAction, getStyleClass, setBackground, setClientListeners, setContentInlineStyle, setContentStyle, setCustomizationId, setDisplayActions, setDisplayHeader, setDisplayShadow, setExpansionMode, setHeaderStyle, 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, 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, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isTransient, markInitialState, processRestoreState, processSaveState, removeAttributeChangeListener, 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, 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

 

Methods inherited from interface oracle.adf.view.core.component.portlet.PortletComponent
getClientId

 

Methods inherited from interface javax.faces.component.ActionSource
isImmediate, setImmediate

 

Field Detail

COMPONENT_TYPE

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

RENDERER_TYPE

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

COMPONENT_FAMILY

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

TYPE

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

Constructor Detail

PortletBase

public PortletBase()

Method Detail

getRendererType

public java.lang.String getRendererType()
Returns the renderer type for this component.
Overrides:
getRendererType in class org.apache.myfaces.trinidad.component.UIXComponentBase
Returns:
Render Type for Portlet Component

getFamily

public java.lang.String getFamily()
Description copied from class: ShowDetailFrame
Returns the component family.
Overrides:
getFamily in class ShowDetailFrame

setTitle

public void setTitle(java.lang.String title)
Description copied from interface: PortletComponent
Set the title property for this portlet component.

The title is displayed as the portlet title in the header of the portlet overriding any title returned in the Portlet rendition.

When the PortletBase view component is instantiated based on a corresponding portlet jsp tag, the value for this property is initially taken from the title attribute on the jsp tag.

Specified by:
setTitle in interface PortletComponent

getTitle

public java.lang.String getTitle()
Description copied from interface: PortletComponent
Get the title set on the Portlet, if any.
Specified by:
getTitle in interface PortletComponent
Returns:
title property value
See Also:
PortletComponent.setTitle(java.lang.String)

setWidth

public void setWidth(java.lang.String width)
Description copied from interface: PortletComponent
The width property will determines the width of the portlet on the page. The value can be expressed in px or as a percentage. The string value should be expressed as npx or n%.

When the PortletBase view component is instantiated based on a corresponding portlet jsp tag, the value is initially for this property is taken from the width attribute on the jsp tag. If no value is specified, the default is auto.

Specified by:
setWidth in interface PortletComponent
Parameters:
width - of the width view component property to set.

getWidth

public java.lang.String getWidth()
Specified by:
getWidth in interface PortletComponent
Returns:
Width of Portlet Component
See Also:
PortletComponent.setWidth(java.lang.String)

setHeight

public void setHeight(java.lang.String height)
Description copied from interface: PortletComponent
The height property will determines the height of the portlet on the page. The value can be expressed in px or as a percentage. The string value should be expressed as npx or n%.

When the PortletBase view component is instantiated based on a corresponding portlet jsp tag, the value is initially for this property is taken from the height attribute on the jsp tag. If no value is specified, the default is auto.

Specified by:
setHeight in interface PortletComponent
Parameters:
height - of the width view component property to set.

getHeight

public java.lang.String getHeight()
Specified by:
getHeight in interface PortletComponent
Returns:
Height of Portlet Component
See Also:
PortletComponent.setHeight(java.lang.String)

setDisplayScrollBar

public void setDisplayScrollBar(boolean displayScrollBar)
Description copied from interface: PortletComponent
The displayScrollBar property determines whether scroll bars for scrolling the content of the Portlet are displayed.

Valid values are true, false and auto. True means that scroll bars will always be present. False means that scroll bars will never be present. Auto means that the scroll bars will be shown if the content size exceeds the specified height and width of the portlet.

When the PortletBase view component is instantiated based on a corresponding portlet jsp tag, the value is initially for this property is taken from the displayScrollBar attribute on the jsp tag. If no value is specified, the default is auto.

Specified by:
setDisplayScrollBar in interface PortletComponent
Parameters:
displayScrollBar - property value to set.

getDisplayScrollBar

public boolean getDisplayScrollBar()
Specified by:
getDisplayScrollBar in interface PortletComponent
Returns:
the displayScrollBar view component property
See Also:
PortletComponent.setDisplayScrollBar(boolean)

setPartialTriggers

public void setPartialTriggers(java.lang.String[] partialTriggers)
Description copied from interface: PortletComponent
Set String array for the partialTriggers for portlet component. The value should be an array of ids for components which, when refreshed during a Partial Page Refresh, will cause this component to also be refreshed.

When the PortletBase view component is instantiated based on a corresponding portlet jsp tag, the value is initially for this property is taken from the partialTriggers attribute on the jsp tag. If no value is specified, the default is true.

Specified by:
setPartialTriggers in interface PortletComponent

getPartialTriggers

public java.lang.String[] getPartialTriggers()
Specified by:
getPartialTriggers in interface PortletComponent
Returns:
an array of partial trigger component IDs.
See Also:
PortletComponent.setPartialTriggers(java.lang.String[])

setValue

public void setValue(java.lang.Object value)
Description copied from interface: PortletComponent
The value property holds the PortletBinding object that this view component uses to interact with the real remote Portlet.
Specified by:
setValue in interface PortletComponent
Parameters:
value - PortletBinding object.

getValue

public java.lang.Object getValue()
Description copied from interface: PortletComponent
Get the Portlet Binding object on this component.
Specified by:
getValue in interface PortletComponent
Returns:
value PortletBinding object

getText

public java.lang.String getText()
Description copied from class: ShowDetailFrame
Returns the title of the component in String form.
Overrides:
getText in class ShowDetailFrame
Returns:
String containing the text attribute value

setAllModesSharedScreen

public void setAllModesSharedScreen(java.lang.String allModesSharedScreen)
Description copied from interface: PortletComponent
The allModesSharedScreen setting on the component determines whether non-show modes (modes other than View for JSR168 or Show for JPDK) render inline within the portlet or on a new page.

When the PortletBase view component is instantiated based on a corresponding portlet jsp tag, the value is initially for this property is taken from the allModesSharedScreen attribute on the jsp tag. If no value is specified, the default is true.

Specified by:
setAllModesSharedScreen in interface PortletComponent
Parameters:
allModesSharedScreen - true to make all Portlet modes render inline. false to make all non-show modes render on a new page.

getAllModesSharedScreen

public java.lang.String getAllModesSharedScreen()
Specified by:
getAllModesSharedScreen in interface PortletComponent
Returns:
allModesSharedScreen setting for this component.
See Also:
PortletComponent.setAllModesSharedScreen(java.lang.String)

setIsNormalModeAvailable

public void setIsNormalModeAvailable(boolean isNormalModeAvailable)
Description copied from interface: PortletComponent
Is the isNormalModeAvailable is a boolean property that determines whether Refresh is show in the Portlet actions menu.

When the PortletBase view component is instantiated based on a corresponding portlet jsp tag, the value is initially for this property is taken from the isNormalModeAvailable attribute on the jsp tag. If no value is specified, the default is true.

Specified by:
setIsNormalModeAvailable in interface PortletComponent
Parameters:
isNormalModeAvailable - true to enable Refresh in the Portlet actions.

getIsNormalModeAvailable

public boolean getIsNormalModeAvailable()
Specified by:
getIsNormalModeAvailable in interface PortletComponent
Returns:
isNormaModeAvailable property value
See Also:
PortletComponent.setIsNormalModeAvailable(boolean)

setIsAboutModeAvailable

public void setIsAboutModeAvailable(boolean isAboutModeAvailable)
Description copied from interface: PortletComponent
The isAboutModeAvailable property determines whether the Portlet view component allows the Portlet's About mode to be shown.

When the PortletBase view component is instantiated based on a corresponding portlet jsp tag, the value is initially for this property is taken from the isAboutModeAvailable attribute on the jsp tag. If no value is specified, the default is true.

Specified by:
setIsAboutModeAvailable in interface PortletComponent

getIsAboutModeAvailable

public boolean getIsAboutModeAvailable()
Specified by:
getIsAboutModeAvailable in interface PortletComponent
Returns:
isAboutModeAvailable view component property
See Also:
PortletComponent.setIsAboutModeAvailable(boolean)

setIsPersonalizeModeAvailable

public void setIsPersonalizeModeAvailable(boolean isPersonalizeModeAvailable)
Description copied from interface: PortletComponent
The isPersonalizeModeAvailable property determines whether the Portlet view component allows the Portlet's Personalize mode to be shown.

When the PortletBase view component is instantiated based on a corresponding portlet jsp tag, the value is initially for this property is taken from the isPersonalizeModeAvailable attribute on the jsp tag. If no value is specified, the default is true.

Specified by:
setIsPersonalizeModeAvailable in interface PortletComponent

getIsPersonalizeModeAvailable

public boolean getIsPersonalizeModeAvailable()
Specified by:
getIsPersonalizeModeAvailable in interface PortletComponent
Returns:
isPersonalizeModeAvailable view component property
See Also:
PortletComponent.setIsPersonalizeModeAvailable(boolean)

setIsHelpModeAvailable

public void setIsHelpModeAvailable(boolean isHelpModeAvailable)
Description copied from interface: PortletComponent
The isHelpModeAvailable property determines whether the Portlet view component allows the Portlet's Help mode to be shown.

When the PortletBase view component is instantiated based on a corresponding portlet jsp tag, the value is initially for this property is taken from the isHelpModeAvailable attribute on the jsp tag. If no value is specified, the default is true.

Specified by:
setIsHelpModeAvailable in interface PortletComponent

getIsHelpModeAvailable

public boolean getIsHelpModeAvailable()
Specified by:
getIsHelpModeAvailable in interface PortletComponent
Returns:
isHelpModeAvailable view component property
See Also:
PortletComponent.setIsHelpModeAvailable(boolean)

setIsCustomizeModeAvailable

public void setIsCustomizeModeAvailable(boolean isCustomizeModeAvailable)
Description copied from interface: PortletComponent
The isCustomizeModeAvailable property determines whether the Portlet view component allows the Portlet's Customize mode to be shown.

When the PortletBase view component is instantiated based on a corresponding portlet jsp tag, the value is initially for this property is taken from the isCustomizeModeAvailable attribute on the jsp tag. If no value is specified, the default is true.

Specified by:
setIsCustomizeModeAvailable in interface PortletComponent

getIsCustomizeModeAvailable

public boolean getIsCustomizeModeAvailable()
Specified by:
getIsCustomizeModeAvailable in interface PortletComponent
Returns:
isCustomizeModeAvailable view component property
See Also:
PortletComponent.setIsCustomizeModeAvailable(boolean)

setIsDetailModeAvailable

public void setIsDetailModeAvailable(boolean isDetailModeAvailable)
Description copied from interface: PortletComponent
The isDetailModeAvailable property determines whether the Portlet view component allows the Portlet's Detail mode to be shown.

When the PortletBase view component is instantiated based on a corresponding portlet jsp tag, the value is initially for this property is taken from the isDetailModeAvailable attribute on the jsp tag. If no value is specified, the default is true.

Specified by:
setIsDetailModeAvailable in interface PortletComponent

getIsDetailModeAvailable

public boolean getIsDetailModeAvailable()
Specified by:
getIsDetailModeAvailable in interface PortletComponent
Returns:
isDetailModeAvailable view component property
See Also:
PortletComponent.setIsDetailModeAvailable(boolean)

setIsPreviewModeAvailable

public void setIsPreviewModeAvailable(boolean isPreviewModeAvailable)
Description copied from interface: PortletComponent
The isPreviewModeAvailable property determines whether the Portlet view component allows the Portlet's Preview mode to be shown.

When the PortletBase view component is instantiated based on a corresponding portlet jsp tag, the value is initially for this property is taken from the isPreviewModeAvailable attribute on the jsp tag. If no value is specified, the default is true.

Specified by:
setIsPreviewModeAvailable in interface PortletComponent

getIsPreviewModeAvailable

public boolean getIsPreviewModeAvailable()
Specified by:
getIsPreviewModeAvailable in interface PortletComponent
Returns:
isDetailModeAvailable view component property
See Also:
PortletComponent.setIsDetailModeAvailable(boolean)

setIsPrintModeAvailable

public void setIsPrintModeAvailable(boolean isPrintModeAvailable)
Description copied from interface: PortletComponent
The isPrintModeAvailable property determines whether the Portlet view component allows the Portlet's Print mode to be shown.

When the PortletBase view component is instantiated based on a corresponding portlet jsp tag, the value is initially for this property is taken from the isPrintModeAvailable attribute on the jsp tag. If no value is specified, the default is true.

Specified by:
setIsPrintModeAvailable in interface PortletComponent

getIsPrintModeAvailable

public boolean getIsPrintModeAvailable()
Specified by:
getIsPrintModeAvailable in interface PortletComponent
Returns:
isPrintModeAvailable view component property
See Also:
PortletComponent.setIsPrintModeAvailable(boolean)

setIsConfigModeAvailable

public void setIsConfigModeAvailable(boolean isConfigModeAvailable)
Description copied from interface: PortletComponent
The isConfigModeAvailable property determines whether the Portlet view component allows the Portlet's Config mode to be shown.

When the PortletBase view component is instantiated based on a corresponding portlet jsp tag, the value is initially for this property is taken from the isConfigModeAvailable attribute on the jsp tag. If no value is specified, the default is true.

Specified by:
setIsConfigModeAvailable in interface PortletComponent

getIsConfigModeAvailable

public boolean getIsConfigModeAvailable()
Specified by:
getIsConfigModeAvailable in interface PortletComponent
Returns:
isConfigModeAvailable view component property
See Also:
PortletComponent.setIsConfigModeAvailable(boolean)

setRenderPortletInIFrame

public void setRenderPortletInIFrame(java.lang.String renderPortletInIFrame)
Description copied from interface: PortletComponent
The renderPortletInIFrame property determines whether the Portlet view component should show the Portlet markup content inside an iFrame.

The allowed values are true, valse or auto. True means that the portlet markup will be displayed in an iframe. False means that the markup will be rendered inline in the containing page. Auto means that the Portlet view component will decide, based on the content of the markup, whether the markup can be safely rendered inline.

When the PortletBase view component is instantiated based on a corresponding portlet jsp tag, the value is initially for this property is taken from the renderPortletInIFrame attribute on the jsp tag. If no value is specified, the default is auto.

Specified by:
setRenderPortletInIFrame in interface PortletComponent
Parameters:
renderPortletInIFrame - true, false or auto

getRenderPortletInIFrame

public java.lang.String getRenderPortletInIFrame()
Specified by:
getRenderPortletInIFrame in interface PortletComponent
Returns:
renderPortletInIFrame view component property
See Also:
PortletComponent.setRenderPortletInIFrame(java.lang.String)

setSubmitUrlParameters

public void setSubmitUrlParameters(boolean submitUrlParameters)
Description copied from interface: PortletComponent
When a link in a Portlet is clicked and that link points to the page on which the Portlet resides, the submitUrlParameter property determines whether the parameters in the link are available to the containing page or only sent back to the Portlet.

A value of true will mean the parameters will be available to the containing page.

When the PortletBase view component is instantiated based on a corresponding portlet jsp tag, the value is initially for this property is taken from the submitUrlParameters attribute on the jsp tag. If no value is specified, the default is false.

Specified by:
setSubmitUrlParameters in interface PortletComponent

getSubmitUrlParameters

public boolean getSubmitUrlParameters()
Specified by:
getSubmitUrlParameters in interface PortletComponent
Returns:
getSubmitUrlParameters view component property
See Also:
PortletComponent.setSubmitUrlParameters(boolean)

setIframeDtd

public void setIframeDtd(java.lang.String iframeDtd)
Description copied from interface: PortletComponent
The iframeDtd attribute controls which HTML dtd is used in the doctype declation for the iframe content document when the Portlet is rendered in an iframe. Valid values are "loose", "strict" and "none". "none" will mean that no DTD is specified.

When the PortletBase view component is instantiated based on a corresponding portlet jsp tag, the value is initially for this property is taken from the iframeDtd attribute on the jsp tag. If no value is specified, the default is loose.

Specified by:
setIframeDtd in interface PortletComponent

getIframeDtd

public java.lang.String getIframeDtd()
Specified by:
getIframeDtd in interface PortletComponent
Returns:
iframeDtd view component property
See Also:
PortletComponent.setIframeDtd(java.lang.String)

applyPortletModeChange

public void applyPortletModeChange(int newMode)
Set a new mode on the Portlet to which this component is bound.
Specified by:
applyPortletModeChange in interface oracle.adf.view.core.component.portlet.PortletComponentBehaviour
Parameters:
newMode - the new portlet mode to set.

applyPortletWindowStateChange

public void applyPortletWindowStateChange(int newWindowState)
Set a new WindowState on the Portlet to which this component is bound.
Specified by:
applyPortletWindowStateChange in interface oracle.adf.view.core.component.portlet.PortletComponentBehaviour
Parameters:
newWindowState - the new portlet window state to set.

broadcast

public void broadcast(javax.faces.event.FacesEvent facesEvent)
               throws javax.faces.event.AbortProcessingException
Description copied from class: ShowDetailFrame
Handle disclosure, resize, delete events Other events are handled by core.ShowDetailFrame.
Specified by:
broadcast in interface oracle.adf.view.core.component.portlet.PortletComponentBehaviour
Overrides:
broadcast in class ShowDetailFrame
Parameters:
facesEvent - the facesEvent object
Throws:
javax.faces.event.AbortProcessingException

handlePartialAdfmEvent

public void handlePartialAdfmEvent(oracle.adf.view.rich.render.ClientEvent clientEvent)
Handle ADFm events propagated raised by a bridge portlet and encoded as a ClientEvent. These ADFm events get delivered into the lifecycle of this portlet Component.
Specified by:
handlePartialAdfmEvent in interface oracle.adf.view.core.component.portlet.PortletComponentBehaviour
Parameters:
clientEvent - the ClientEvent encoding the ADFm event.

handleDataDirtyEvent

public void handleDataDirtyEvent(oracle.adf.view.rich.render.ClientEvent clientEvent)
Handle dataDirty status carrying events sent to pass the data dirty status from PPR (resource request) in the client to the server.

getPortletBinding

public final oracle.adf.model.portlet.binding.PortletBinding getPortletBinding()
Deprecated. Interact with the PortletModel directly.
Helper method to get the Portletbindings. Return the Portlet Binding. Sets the error state on the PortletBase if the Binding is null which will cause an error rendition to be shown.
Specified by:
getPortletBinding in interface PortletComponent
Returns:
the PortletBinding object.

getPortletModel

public oracle.adf.model.portlet.binding.PortletModel getPortletModel()
Helper method to get the PortletModel. Return the PortletModel. Sets the error state on the PortletBase if the Binding is null which will cause an error rendition to be shown.
Specified by:
getPortletModel in interface PortletComponent
Returns:
the PortletModel for this Component

setErrorMessage

public void setErrorMessage(javax.faces.application.FacesMessage.Severity severity,
                            java.lang.Throwable error)
Stores an error state on the portlet component. If called during a Faces lifecycle before the component has been rendered an appropriate message will then be displayed in place of the portlet rendition.
Specified by:
setErrorMessage in interface oracle.adf.view.core.component.portlet.PortletComponentBehaviour
Parameters:
severity - the error severity.
error - the Throwable cause of the error.

getBeanType

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

addActionListener

public void addActionListener(javax.faces.event.ActionListener listener)
Specified by:
addActionListener in interface javax.faces.component.ActionSource

removeActionListener

public void removeActionListener(javax.faces.event.ActionListener listener)
Specified by:
removeActionListener in interface javax.faces.component.ActionSource

getActionListeners

public javax.faces.event.ActionListener[] getActionListeners()
Specified by:
getActionListeners in interface javax.faces.component.ActionSource

getActionListener

public javax.faces.el.MethodBinding getActionListener()
Specified by:
getActionListener in interface javax.faces.component.ActionSource

getAction

public javax.faces.el.MethodBinding getAction()
Specified by:
getAction in interface javax.faces.component.ActionSource

setAction

public void setAction(javax.faces.el.MethodBinding mb)
Specified by:
setAction in interface javax.faces.component.ActionSource

setActionListener

public void setActionListener(javax.faces.el.MethodBinding mb)
Specified by:
setActionListener in interface javax.faces.component.ActionSource

isRendered

public boolean isRendered()
Description copied from class: ShowDetailFrame
Determines if the ShowDetailFrame can be rendered.

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.

Overrides:
isRendered in class ShowDetailFrame
Returns:
true if this ShowDetailFrame can be rendered.

getCachedActionsAvailable

public java.util.List getCachedActionsAvailable()
Public wrapper to get the getActionsAvailable method on the ShowDetailFrame. This is intended purely for the use of the PortletRenderer.

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object state)
Description copied from class: ShowDetailFrame
Restore state.
Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class ShowDetailFrame

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)
Description copied from class: ShowDetailFrame
Save state
Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class ShowDetailFrame

getDebugValue

public java.lang.String getDebugValue()
Specified by:
getDebugValue in interface oracle.portlet.client.utils.debug.DebugHelper

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle WebCenter
11g Release 1 (11.1.1.4.0)
E15995-03


Copyright © 2009, 2011, Oracle and/or its affiliates. All rights reserved.