Page Interface
DEPRECATED com.bea.portal is only useful in the compatibility domain. For the new portal framework please
use the classes under the com.bea.netuix package
- public interface Page
extends com.bea.portal.model.PortalResource
Interface Page
represents a panel within a rendered portal
view. In this the portal framework this page would be expected to have
been defined by the EBCC.
-
All Superinterfaces
-
com.bea.portal.model.PortalResource
, com.bea.portal.model.PortalScopedObject
public PageIdentifier |
-
getIdentifier ()
- Returns the unique identifier for this
Page .
|
public String |
-
getImageName (int imageType)
- Returns the filename of the image defined for the specified image type.
|
public List |
-
getLayouts ()
- Returns a
List of LayoutIdentifier objects
for the layouts available for selection on this page.
|
public Portlet |
-
getPortlet (PortletIdentifier portletId)
- Returns a
Portlet corresponding to the
PortletIdentifier specified.
|
public List |
-
getPortlets ()
- Returns a
List of PortletIdentifier objects
for the portlets available for selection on this page.
|
DISPLAY_TYPE_IMAGE
public static final String
DISPLAY_TYPE_IMAGE
DISPLAY_TYPE_TEXT
public static final String
DISPLAY_TYPE_TEXT
IMAGE_DEFAULT
public static final int IMAGE_DEFAULT
- Constant to represent image of type Default.
IMAGE_ROLLOVER
public static final int IMAGE_ROLLOVER
- Constant to represent image of type Rollover.
IMAGE_SELECTED
public static final int IMAGE_SELECTED
- Constant to represent image of type Selected.
MAX_IMAGES
public static final int MAX_IMAGES
- Constant to represent the maximum number of images.
PAGE_AVAILABLE
public static final int PAGE_AVAILABLE
- Constant to represent attribute available.
PAGE_MANDATORY
public static final int PAGE_MANDATORY
- Constant to represent attribute Mandatory.
PAGE_VISIBLE
public static final int PAGE_VISIBLE
- Constant to represent attribute Visible.
getIdentifier() Method
public PageIdentifier
getIdentifier()
Returns the unique identifier for this Page
.
Returns
PageIdentifier
for this Page
.
getImageName(int) Method
public String
getImageName(int imageType)
Returns the filename of the image defined for the specified image type.
Valid values are:
Page.IMAGE_DEFAULT
Page.IMAGE_SELECTED
Page.IMAGE_ROLLOVER
These filenames are expected to be defined in the EBCC and do not need to
include directory information but should include the appropriate
filename extension (eg. HomePageRollover.gif ).
Parameters
-
imageType
- a constant specifying the image type required.
Returns
- the filename defined for the image type specified.
getLayouts() Method
public List
getLayouts()
Returns a 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.
Returns
- the set of layouts available on this page.
getPortlet(PortletIdentifier) Method
public Portlet
getPortlet(PortletIdentifier
portletId)
Returns a Portlet
corresponding to the
PortletIdentifier
specified.
Parameters
-
portletId
- identifier for portlet required.
Returns
Portlet
as specified.
getPortlets() Method
public List
getPortlets()
Returns a 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.
Returns
- the set of portlets available on this page.