|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter 11g Release 1 (11.1.1.3.0) E15995-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
---|
static final java.lang.String PORTLET_MODE_CHANGE
Method Detail |
---|
void setWidth(java.lang.String width)
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.
width
- of the width view component property to set.java.lang.String getWidth()
setWidth(java.lang.String)
void setHeight(java.lang.String height)
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.
height
- of the width view component property to set.java.lang.String getHeight()
setHeight(java.lang.String)
void setDisplayScrollBar(boolean displayScrollBar)
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.
displayScrollBar
- property value to set.boolean getDisplayScrollBar()
setDisplayScrollBar(boolean)
void setPartialTriggers(java.lang.String[] partialTriggers)
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.
java.lang.String[] getPartialTriggers()
setPartialTriggers(java.lang.String[])
void setValue(java.lang.Object value)
value
- PortletBinding object.java.lang.Object getValue()
void setTitle(java.lang.String title)
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.
java.lang.String getTitle()
setTitle(java.lang.String)
void setAllModesSharedScreen(java.lang.String allModesSharedScreen)
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.
allModesSharedScreen
- true to make all Portlet modes render inline. false to make all non-show modes render on a new page.java.lang.String getAllModesSharedScreen()
setAllModesSharedScreen(java.lang.String)
void setIsNormalModeAvailable(boolean isNormalModeAvailable)
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.
isNormalModeAvailable
- true to enable Refresh in the Portlet actions.boolean getIsNormalModeAvailable()
setIsNormalModeAvailable(boolean)
void setIsAboutModeAvailable(boolean isAboutModeAvailable)
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.
isAboutModeAvailable
-boolean getIsAboutModeAvailable()
setIsAboutModeAvailable(boolean)
void setIsPersonalizeModeAvailable(boolean isPersonalizeModeAvailable)
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.
isPersonalizeModeAvailable
-boolean getIsPersonalizeModeAvailable()
setIsPersonalizeModeAvailable(boolean)
void setIsHelpModeAvailable(boolean isHelpModeAvailable)
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.
isHelpModeAvailable
-boolean getIsHelpModeAvailable()
setIsHelpModeAvailable(boolean)
void setIsCustomizeModeAvailable(boolean isCustomizeModeAvailable)
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.
isCustomizeModeAvailable
-boolean getIsCustomizeModeAvailable()
setIsCustomizeModeAvailable(boolean)
void setIsDetailModeAvailable(boolean isDetailModeAvailable)
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.
isDetailModeAvailable
-boolean getIsDetailModeAvailable()
setIsDetailModeAvailable(boolean)
void setIsPreviewModeAvailable(boolean isPreviewModeAvailable)
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.
isPreviewModeAvailable
-boolean getIsPreviewModeAvailable()
setIsDetailModeAvailable(boolean)
void setIsPrintModeAvailable(boolean isPrintModeAvailable)
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.
isPrintModeAvailable
-boolean getIsPrintModeAvailable()
setIsPrintModeAvailable(boolean)
void setIsConfigModeAvailable(boolean isConfigModeAvailable)
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.
isConfigModeAvailable
-boolean getIsConfigModeAvailable()
setIsConfigModeAvailable(boolean)
void setRenderPortletInIFrame(java.lang.String renderPortletInIFrame)
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.
renderPortletInIFrame
- true, false or autojava.lang.String getRenderPortletInIFrame()
setRenderPortletInIFrame(java.lang.String)
void setSubmitUrlParameters(boolean submitUrlParameters)
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.
submitUrlParameters
-boolean getSubmitUrlParameters()
setSubmitUrlParameters(boolean)
void setIframeDtd(java.lang.String iframeDtd)
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.
iframeDtd
-java.lang.String getIframeDtd()
setIframeDtd(java.lang.String)
oracle.adf.model.portlet.binding.PortletModel getPortletModel()
oracle.adf.model.portlet.binding.PortletBinding getPortletBinding()
java.lang.String getClientId(javax.faces.context.FacesContext facesContext)
|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter 11g Release 1 (11.1.1.3.0) E15995-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |