|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Portlet
Interface that represents the deployed code unit for a portlet, as specified in the deployment descriptor. Properties of the portlet are defined by the portlet programmer and deployer, typically in the deployment descriptor, and cannot be altered after deployment.
All methods that take or return supported markups as strings will also accept
or return mimetype strings. For example, for a portlet supporting the html markup,
both supportsMarkup("html") and supportsMarkup("text/html") will return true
.
The supported mimetypes must not contain a character set definition and must not
contain wildcards.
Method Summary | |
---|---|
MetaData<java.lang.String,? extends java.util.Map.Entry<java.lang.String,java.lang.String>> |
getInitParameters()
Returns the init parameters of the portlet as specified in the deployment descriptor |
MetaData<java.lang.String,? extends java.util.Map.Entry<java.lang.String,java.lang.String>> |
getMetaData()
Returns the same preferences as getPortletPreferencesLayer() |
ListModel |
getPortletModes()
Returns a ListModel object of PortletMode objects that are contained in the
portlet's list of supported portlet modes. |
ListModel |
getPortletModes(java.lang.String markup)
Returns a ListModel object of PortletMode objects that are contained in the
portlet's list of supported portlet modes for a specific markup |
java.lang.String |
getPortletName()
Returns the portlet name as specified in the deployment descriptor |
PortletPreferences |
getPortletPreferencesLayer()
Returns the preferences that are defined in the deployment descriptor for this portlet |
boolean |
supportsPortletMode(javax.portlet.PortletMode mode)
Checks if a given portlet mode is in the list of supported portlet modes. |
boolean |
supportsPortletMode(javax.portlet.PortletMode mode,
java.lang.String markup)
Checks if a given portlet mode is in the list of supported portlet modes for the given markup. |
boolean |
supportsWindowState(javax.portlet.WindowState state)
Checks if a given window state is in the list of supported window states. |
boolean |
supportsWindowState(javax.portlet.WindowState state,
java.lang.String markup)
Checks if a given window state is in the list of supported window states for the given markup. |
Methods inherited from interface com.ibm.portal.Identifiable |
---|
getObjectID |
Methods inherited from interface com.ibm.portal.admin.MarkupCapable |
---|
getMarkups, supportsMarkup, supportsMarkup |
Methods inherited from interface com.ibm.portal.Localized |
---|
getDescription, getLocales, getTitle |
Method Detail |
---|
java.lang.String getPortletName()
MetaData<java.lang.String,? extends java.util.Map.Entry<java.lang.String,java.lang.String>> getInitParameters()
PortletPreferences getPortletPreferencesLayer()
getPortletPreferencesLayer
in interface PortletPreferencesProvider
null
.MetaData<java.lang.String,? extends java.util.Map.Entry<java.lang.String,java.lang.String>> getMetaData()
getPortletPreferencesLayer()
getMetaData
in interface MetaDataProvider
getMetaData
in interface PortletPreferencesProvider
MetaData
MetaDataProvider
ListModel getPortletModes() throws ModelException
ListModel
object of PortletMode
objects that are contained in the
portlet's list of supported portlet modes.
PortletMode
objects, never null
ModelException
- in case the portlet modes cannot be obtainedListModel getPortletModes(java.lang.String markup) throws ModelException
ListModel
object of PortletMode
objects that are contained in the
portlet's list of supported portlet modes for a specific markup
markup
- The markup for which the supported modes are requested.
PortletMode
objects, never null
ModelException
- in case the portlet modes cannot be obtainedboolean supportsPortletMode(javax.portlet.PortletMode mode) throws ModelException
mode
- The portlet mode that is to be checked.
true
if the mode is in the list of supported modes for
any supported markup, false
if not.
ModelException
- in case the portlet modes cannot be obtainedboolean supportsPortletMode(javax.portlet.PortletMode mode, java.lang.String markup) throws ModelException
mode
- The portlet mode that is to be checked.markup
- The markup for which the mode is to be checked.
true
if the markup is in the list of supported markups and the
mode is in the list of supported modes for that markup, false
if not.
ModelException
- in case the portlet modes cannot be obtainedboolean supportsWindowState(javax.portlet.WindowState state) throws ModelException
state
- The window state that is to be checked.
true
if the mode is in the list of supported window states for
any supported markup, false
if not.
ModelException
- in case the window states cannot be obtainedboolean supportsWindowState(javax.portlet.WindowState state, java.lang.String markup) throws ModelException
mode
- The window state that is to be checked.markup
- The markup for which the mode is to be checked.
true
if the markup is in the list of supported markups and the
window state is in the list of supported window states for that markup, false
if not.
ModelException
- in case the windwo states cannot be obtained
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |