Skip navigation links

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


oracle.adf.view.core.component.portlet
Interface PortletComponent

All Known Implementing Classes:
PortletBase, PortletBase

public interface PortletComponent

Field Summary
static java.lang.String PORTLET_MODE_CHANGE
           

 

Method Summary
 java.lang.String getAllModesSharedScreen()
           
 java.lang.String getClientId(javax.faces.context.FacesContext facesContext)
           
 boolean getDisplayScrollBar()
           
 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.  
 oracle.adf.model.portlet.binding.PortletModel getPortletModel()
          Get the PortletModel object associated with this component.
 java.lang.String getRenderPortletInIFrame()
           
 boolean getSubmitUrlParameters()
           
 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 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 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.

 

Field Detail

PORTLET_MODE_CHANGE

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

Method Detail

setWidth

void setWidth(java.lang.String width)
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.

Parameters:
width - of the width view component property to set.

getWidth

java.lang.String getWidth()
Returns:
Width of Portlet Component
See Also:
setWidth(java.lang.String)

setHeight

void setHeight(java.lang.String height)
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.

Parameters:
height - of the width view component property to set.

getHeight

java.lang.String getHeight()
Returns:
Height of Portlet Component
See Also:
setHeight(java.lang.String)

setDisplayScrollBar

void setDisplayScrollBar(boolean displayScrollBar)
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.

Parameters:
displayScrollBar - property value to set.

getDisplayScrollBar

boolean getDisplayScrollBar()
Returns:
the displayScrollBar view component property
See Also:
setDisplayScrollBar(boolean)

setPartialTriggers

void setPartialTriggers(java.lang.String[] partialTriggers)
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.


getPartialTriggers

java.lang.String[] getPartialTriggers()
Returns:
an array of partial trigger component IDs.
See Also:
setPartialTriggers(java.lang.String[])

setValue

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.
Parameters:
value - PortletBinding object.

getValue

java.lang.Object getValue()
Get the Portlet Binding object on this component.
Returns:
value PortletBinding object

setTitle

void setTitle(java.lang.String title)
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.


getTitle

java.lang.String getTitle()
Get the title set on the Portlet, if any.
Returns:
title property value
See Also:
setTitle(java.lang.String)

setAllModesSharedScreen

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.

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.

Parameters:
allModesSharedScreen - true to make all Portlet modes render inline. false to make all non-show modes render on a new page.

getAllModesSharedScreen

java.lang.String getAllModesSharedScreen()
Returns:
allModesSharedScreen setting for this component.
See Also:
setAllModesSharedScreen(java.lang.String)

setIsNormalModeAvailable

void setIsNormalModeAvailable(boolean isNormalModeAvailable)
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.

Parameters:
isNormalModeAvailable - true to enable Refresh in the Portlet actions.

getIsNormalModeAvailable

boolean getIsNormalModeAvailable()
Returns:
isNormaModeAvailable property value
See Also:
setIsNormalModeAvailable(boolean)

setIsAboutModeAvailable

void setIsAboutModeAvailable(boolean isAboutModeAvailable)
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.

Parameters:
isAboutModeAvailable -

getIsAboutModeAvailable

boolean getIsAboutModeAvailable()
Returns:
isAboutModeAvailable view component property
See Also:
setIsAboutModeAvailable(boolean)

setIsPersonalizeModeAvailable

void setIsPersonalizeModeAvailable(boolean isPersonalizeModeAvailable)
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.

Parameters:
isPersonalizeModeAvailable -

getIsPersonalizeModeAvailable

boolean getIsPersonalizeModeAvailable()
Returns:
isPersonalizeModeAvailable view component property
See Also:
setIsPersonalizeModeAvailable(boolean)

setIsHelpModeAvailable

void setIsHelpModeAvailable(boolean isHelpModeAvailable)
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.

Parameters:
isHelpModeAvailable -

getIsHelpModeAvailable

boolean getIsHelpModeAvailable()
Returns:
isHelpModeAvailable view component property
See Also:
setIsHelpModeAvailable(boolean)

setIsCustomizeModeAvailable

void setIsCustomizeModeAvailable(boolean isCustomizeModeAvailable)
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.

Parameters:
isCustomizeModeAvailable -

getIsCustomizeModeAvailable

boolean getIsCustomizeModeAvailable()
Returns:
isCustomizeModeAvailable view component property
See Also:
setIsCustomizeModeAvailable(boolean)

setIsDetailModeAvailable

void setIsDetailModeAvailable(boolean isDetailModeAvailable)
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.

Parameters:
isDetailModeAvailable -

getIsDetailModeAvailable

boolean getIsDetailModeAvailable()
Returns:
isDetailModeAvailable view component property
See Also:
setIsDetailModeAvailable(boolean)

setIsPreviewModeAvailable

void setIsPreviewModeAvailable(boolean isPreviewModeAvailable)
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.

Parameters:
isPreviewModeAvailable -

getIsPreviewModeAvailable

boolean getIsPreviewModeAvailable()
Returns:
isDetailModeAvailable view component property
See Also:
setIsDetailModeAvailable(boolean)

setIsPrintModeAvailable

void setIsPrintModeAvailable(boolean isPrintModeAvailable)
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.

Parameters:
isPrintModeAvailable -

getIsPrintModeAvailable

boolean getIsPrintModeAvailable()
Returns:
isPrintModeAvailable view component property
See Also:
setIsPrintModeAvailable(boolean)

setIsConfigModeAvailable

void setIsConfigModeAvailable(boolean isConfigModeAvailable)
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.

Parameters:
isConfigModeAvailable -

getIsConfigModeAvailable

boolean getIsConfigModeAvailable()
Returns:
isConfigModeAvailable view component property
See Also:
setIsConfigModeAvailable(boolean)

setRenderPortletInIFrame

void setRenderPortletInIFrame(java.lang.String renderPortletInIFrame)
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.

Parameters:
renderPortletInIFrame - true, false or auto

getRenderPortletInIFrame

java.lang.String getRenderPortletInIFrame()
Returns:
renderPortletInIFrame view component property
See Also:
setRenderPortletInIFrame(java.lang.String)

setSubmitUrlParameters

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.

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.

Parameters:
submitUrlParameters -

getSubmitUrlParameters

boolean getSubmitUrlParameters()
Returns:
getSubmitUrlParameters view component property
See Also:
setSubmitUrlParameters(boolean)

setIframeDtd

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

Parameters:
iframeDtd -

getIframeDtd

java.lang.String getIframeDtd()
Returns:
iframeDtd view component property
See Also:
setIframeDtd(java.lang.String)

getPortletModel

oracle.adf.model.portlet.binding.PortletModel getPortletModel()
Get the PortletModel object associated with this component.
Returns:
the PortletBinding object.

getPortletBinding

oracle.adf.model.portlet.binding.PortletBinding getPortletBinding()
Deprecated. 
Get the PortletBinding object
Returns:
the PortletBinding for the components value attribute.

getClientId

java.lang.String getClientId(javax.faces.context.FacesContext facesContext)

Skip navigation links

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


Copyright © 2009, 2010, Oracle. All rights reserved.