|
© 2005 BEA Systems, Inc. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Interface PageState
represents the dynamic view of a page by
a portal user. After all appropriate personalizations, attributes and
entitlements have been considered for a given page and if that page is
evaluated to be visible to the current user then a PageState
will be available.
Method Summary | |
String |
getDisplayName()
Deprecated. Method getDisplayName retrieves the personalized display
name of the associated portal page. |
String |
getDisplayType()
Deprecated. |
PortletIdentifier |
getEditedPortlet()
Deprecated. If there is a portlet currently being edited on this page, return its identifier. |
String |
getImageName(int imageType)
Deprecated. Method getImageName retieves the image name for the image
of type specified. |
int |
getIndex()
Deprecated. Method getIndex returns an integer representing the position
of this page in the ordering of all portal pages. |
LayoutIdentifier |
getLayoutIdentifier()
Deprecated. Method getLayoutIdentifier retrieves an identifier for the
layout specified to be used to render this portal page. |
List |
getLayouts()
Deprecated. Returns a List of LayoutIdentifier objects
for the layouts available for selection on this page. |
PortletIdentifier |
getMaximizedPortlet()
Deprecated. If there is a portlet currently maximized on this page, return its identifier. |
PageIdentifier |
getPageIdentifier()
Deprecated. Method getPageIdentifier retrieves the identifier of
the portal page that this object is the state of. |
List |
getPortlets()
Deprecated. Returns a List of PortletIdentifier objects
for the portlets available for selection on this page. |
List |
getPortletsForPlaceholder(String placeholderId)
Deprecated. Method getPortletsForPlaceholder retrieves the list of all
PortletIdentifier objects that are associated with visible
portlets situated within the supplied placeholder. |
PortletState |
getPortletState(PortletIdentifier portletId)
Deprecated. Method getPortletState retrieves the state of the portlet
specified for the current user. |
Iterator |
getPortletStates()
Deprecated. Method getPortletStates retrieves the state of all
portlets which are visible to the current user. |
Boolean |
isDisplayMutable()
Deprecated. |
void |
setEditedPortlet(PortletIdentifier portletId)
Deprecated. Set a portlet to edit on this page. |
void |
setMaximizedPortlet(PortletIdentifier portletId)
Deprecated. Set a portlet to render as maximized on this page. |
Method Detail |
public String getDisplayName()
getDisplayName
retrieves the personalized display
name of the associated portal page. This data is personalized to the
associated user at group scope.
String
used to describe the portal page
to the associated user.public String getDisplayType()
public PortletIdentifier getEditedPortlet()
PortletIdentifier
representing the
portlet that is currently being edited.public String getImageName(int imageType)
getImageName
retieves the image name for the image
of type specified. Valid values are:
Page.IMAGE_DEFAULT
Page.IMAGE_SELECTED
Page.IMAGE_ROLLOVER
imageType
- a constant specifying the image type required.
public int getIndex()
getIndex
returns an integer representing the position
of this page in the ordering of all portal pages.
int
representing the position
of this portal page.public LayoutIdentifier getLayoutIdentifier()
getLayoutIdentifier
retrieves an identifier for the
layout specified to be used to render this portal page. This identifier
simply contains a String
which maps to a subdirectory under
the defined layout directory. All the extra resources required to render
the layout template should be loaded from this directory. This data is
associated to the user at user scope.
LayoutIdentifier
used to specify the
layout template to use to render this portal page.public List getLayouts()
List
of LayoutIdentifier
objects
for the layouts available for selection on this page.
Note: This is the set of layouts available for group administrators
to select from as defined in the EBCC and not necessarily the list
an end user will see.
public PortletIdentifier getMaximizedPortlet()
PortletIdentifier
representing the
portlet that is currently maximized.public PageIdentifier getPageIdentifier()
getPageIdentifier
retrieves the identifier of
the portal page that this object is the state of.
PageIdentifier
used to specify the
portal page that this object is the state of.public List getPortlets()
List
of PortletIdentifier
objects
for the portlets available for selection on this page.
Note: This is the set of portlets available for group administrators
to select from, as defined in the EBCC and not necessarily the list an
end user will see.
public List getPortletsForPlaceholder(String placeholderId)
getPortletsForPlaceholder
retrieves the list of all
PortletIdentifier
objects that are associated with visible
portlets situated within the supplied placeholder.
placeholderId
- A parameter of type String used to specify the
placeholder for which we should return portlet states.
- Returns:
- A value of type
List
containing the portlet states
associated with visible portlets in the supplied placeholder.
public PortletState getPortletState(PortletIdentifier portletId)
getPortletState
retrieves the state of the portlet
specified for the current user.
portletId
- A parameter of type PortletIdentifier
used to specify
the portlet for which state is required.
PortletState
representing the state
of the portlet specified.public Iterator getPortletStates()
getPortletStates
retrieves the state of all
portlets which are visible to the current user.
Iterator
over a set of objects of type
PortletState
representing the state of all visible
portlets.public Boolean isDisplayMutable()
public void setEditedPortlet(PortletIdentifier portletId)
portletId
- A parameter of type PortletIdentifier
used to specify
the portlet that is to be edited.public void setMaximizedPortlet(PortletIdentifier portletId)
portletId
- A parameter of type PortletIdentifier
used to specify
the portlet that is to be maximized.
|
© 2005 BEA Systems, Inc. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |