| com.nabhinc.portal.model.Renderable
All known Subclasses: com.nabhinc.portal.model.PortletWindow, com.nabhinc.portal.model.BaseRenderable,
| Renderable | | public interface Renderable (Code) | |
author:
Padmanabh Dabke
author:
(c) 2006 Nabh Information Systems, Inc. All Rights Reserved. |
| addPortletWindows | | void addPortletWindows(List<PortletWindow> windowList)(Code) | | Add portlet windows in this renderable to the list.
Parameters:
windowList - |
| computeTemplatePath | | void computeTemplatePath(ServletContext servletContext, String appPath, String theme)(Code) | | Computes path to the template after checking existence of app-theme specific,
app-specific, theme-specific template. If none is found, it falls back to
files in templates directory.
Parameters:
servletContext -
Parameters:
appName -
Parameters:
appId -
Parameters:
theme - |
| getBorderWidth | | int getBorderWidth()(Code) | | Get renderable border width
|
| getContentBelowMainMenu | | String getContentBelowMainMenu()(Code) | | Returns content to be displayed below the main menu bar of a portal page.
Most layouts return a spacer div. Horizontal menu layout returns an empty
string since it does not want a gap between the main menu and the sub-menu.
Cascading menu layout returns a nested list of menu options.
Content to be displayed below the main menu bar. |
| getId | | String getId()(Code) | | Get a token that uniquely identifies this renderable within the user config.
|
| getNumericId | | int getNumericId()(Code) | | Get numeric ID that is unique within a portal application
|
| getPortalPage | | PortalPage getPortalPage()(Code) | | Get the portal page this renderable belongs to.
Top level portal page that contains this renderable. |
| getRefreshSeconds | | int getRefreshSeconds()(Code) | | Get the renderable refresh period in seconds.
Refresh period in seconds. |
| getTemplate | | String getTemplate()(Code) | | Get template name
Relative template path |
| getTemplatePath | | String getTemplatePath()(Code) | | Computed path to the template after checking existence of app-theme specific,
app-specific, theme-specific template. If none is found, it falls back to
files in templates directory.
|
| isTitleShown | | boolean isTitleShown()(Code) | | Is renderable title displayed?
|
| removePortletWindow | | boolean removePortletWindow(PortletWindow pWindow)(Code) | | Remove portlet window if this renderable contains it.
Returns true if it contains the window.
|
| setBorderWidth | | void setBorderWidth(int bWidth)(Code) | | Set renderable border width
|
| setIdPrefix | | void setIdPrefix(String prefix)(Code) | | Supplies the portal application prefix so that the renderables can
generate global id.
Parameters:
prefix - |
| setPortalPage | | void setPortalPage(PortalPage p)(Code) | | Set the portal page this renderable belongs to.
Parameters:
p - PortalPage this Renderable belongs to. |
| setRefreshSeconds | | void setRefreshSeconds(int sec)(Code) | | Set renderable refresh period
Parameters:
sec - Refresh period in seconds |
| setTemplate | | void setTemplate(String template)(Code) | | Set template name
Parameters:
template - |
| setTitleShown | | void setTitleShown(boolean flag)(Code) | | Flag indicating if the renderable title is displayed.
|
|
|