|
Novell exteNd Director 5.2 API |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Interface for managing the page layout information of a specific portal application.
Method Summary | |
void |
addComponent(EbiPortalContext context,
String componentName,
String sectionID)
Adds a component to the selection list. |
void |
addComponent(EbiPortalContext context,
String componentName,
String sectionID,
String instanceID)
Adds a component to the selection list. |
EbiPageLayoutInfo |
cloneCopy()
Clone this object, and reset the read-only flag in the cloned object. |
EbiPageLayoutInfo |
cloneCopy(String anotherPortalID)
Clone this object, and reset the read-only flag, page name, and the portal ID in the cloned object. |
String[] |
getAllowedSectionIDs(EbiPortalContext context)
Gets a list of allowed section IDs according to the selected layout. |
NodeList |
getComponentsBySection(String sectionID)
Gets the list of selected components by a specified section. |
String |
getDescription()
Gets the description of this layout page. |
String |
getDisplayName()
Gets the layout page display name. |
String |
getPageLayoutType()
Gets the type of this page layout. |
String |
getPageName()
Gets the page name of a page layout. |
String |
getPortalID()
Gets Portal ID. |
String |
getPortalLayoutID()
Gets the portal layout identifier. |
String[] |
getSectionIDs()
Gets a list of section IDs that contains selected components. |
String |
getSelectedComponentsXML()
Gets the XML String that contains only the selected components. |
String |
getStyleID()
Gets the style ID which the page uses to style it - typically for custom layouts. |
void |
removeComponent(EbiPortalContext context,
String componentName,
String instanceID)
Remove a component from the selection list. |
void |
removeComponent(EbiPortalContext context,
String componentName,
String instanceID,
String from)
Remove a component from the selection list. |
void |
setDescription(String description)
Sets the description of this layout page. |
void |
setDisplayName(String displayName)
Sets the display name of this layout page. |
void |
setPageName(String pageName)
Sets a page name for a page layout. |
void |
setPortalID(String portalID)
Sets Portal ID. |
void |
setPortalLayoutID(EbiPortalContext context,
String layoutID)
Sets the portal layout identifier and validate the sections with the new layout. |
void |
setPortalLayoutID(String layoutID)
Sets the portal layout identifier. |
void |
updateSectionComponents(EbiPortalContext context,
String sectionID,
String[] comps)
Updates the order of components in the specified section. |
void |
validateLayout(EbiPortalContext context)
Validates the selected components to see if the sections that the components are binding to are consistent with the selected layout. |
Method Detail |
public String getPageLayoutType()
public String getPortalID()
public String getPageName()
public String getDisplayName()
public String getDescription()
public String getPortalLayoutID()
public String getStyleID()
public String getSelectedComponentsXML()
public NodeList getComponentsBySection(String sectionID)
sectionID
- a section identifier.public void updateSectionComponents(EbiPortalContext context, String sectionID, String[] comps) throws EboUnrecoverableSystemException, EboSecurityException
context
- an EbiPortalContext object.sectionID
- a section identifier.comps
- a String array of components (name, instanceid pairs)public String[] getSectionIDs()
public String[] getAllowedSectionIDs(EbiPortalContext context) throws EboUnrecoverableSystemException, EboSecurityException
context
- an EbiPortalContext object.public void validateLayout(EbiPortalContext context) throws EboUnrecoverableSystemException, EboSecurityException
context
- an EbiPortalContext object.public void setPortalID(String portalID)
portalID
- a portal identifier.public void setPageName(String pageName)
pageName
- a page name.public void setDisplayName(String displayName)
displayName
- a display name.public void setDescription(String description)
description
- a description.public void setPortalLayoutID(String layoutID)
layoutID
- a portal layout identifier.public void setPortalLayoutID(EbiPortalContext context, String layoutID) throws EboUnrecoverableSystemException, EboSecurityException
context
- an EbiPortalContext.layoutID
- a portal layout identifier.public void addComponent(EbiPortalContext context, String componentName, String sectionID) throws EboUnrecoverableSystemException, EboSecurityException
context
- an EbiPortalContext object.componentName
- a component name.sectionID
- a section identifier where the component is going to be added.public void addComponent(EbiPortalContext context, String componentName, String sectionID, String instanceID) throws EboUnrecoverableSystemException, EboSecurityException
context
- an EbiPortalContext object.componentName
- a component name.sectionID
- a section identifier where the component
is going to be added to.instanceID
- a predefined portlet/component instance IDpublic void removeComponent(EbiPortalContext context, String componentName, String instanceID, String from) throws EboUnrecoverableSystemException, EboSecurityException
context
- an EbiPortalContext object.componentName
- a component name.instanceID
- a component instance identifier.from
- a section identifier where the component is going to be removed from.public void removeComponent(EbiPortalContext context, String componentName, String instanceID) throws EboUnrecoverableSystemException, EboSecurityException
context
- an EbiPortalContext object.componentName
- a component name.instanceID
- a component instance identifier.public EbiPageLayoutInfo cloneCopy()
public EbiPageLayoutInfo cloneCopy(String anotherPortalID)
anotherPortalID
- another portal war's ID.
|
Novell exteNd Director 5.2 API |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |