|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SoloAccessor
Interface providing read-access to Solo information. The state includes as maximum one portlet in SOLO mode. This portlet will be displayed as the only portlet without any additional navigation information. SOLO can be used to implements popup windows that display only the content of one single portlet or modal dialogs.
SOLO is a portal state and not a portlet window state of a specific portlet. In order to provide the portlet with the information that the portal is currently in SOLO mode and the current portlet is the selected portlet the SOLO mode is provided as portlet window state to the portlet.
Method Summary | |
---|---|
ObjectID |
getReturnSelection()
Returns the ObjectID representing the selection
that has been associated with the portlet being in solo state. |
ObjectID |
getSoloPortlet()
Returns the ObjectID of the portlet window
which is in Solo state. |
Methods inherited from interface com.ibm.portal.Disposable |
---|
dispose |
Method Detail |
---|
ObjectID getSoloPortlet() throws InvalidPortletIdException
ObjectID
of the portlet window
which is in Solo state. If there is no such portlet, the
method will return null
.
ObjectID
of the portlet which is
in Solo window state (if any).
InvalidPortletIdException
- if the portlet's identifier
could not be converted to ObjectID
.ObjectID getReturnSelection() throws InvalidSelectionException
ObjectID
representing the selection
that has been associated with the portlet being in solo state.
In general, the selection corresponds to the page that will be
displayed when leaving the solo state of the respective portlet.
If there is no such selection information available, the method
will return null
.
ObjectID
of the selection that has
been associated with the respective portlet being in Solo state
(if any).
InvalidSelectionException
- if the selection identifier
could not be converted to ObjectID
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |