|
Novell exteNd Director 5.2 API |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Provides a generic interface for the portal context object.
Field Summary | |
static int |
PERSIST
When setting state this indicates that the state is stored int the user persistent store |
static int |
REQUEST
When setting state this indicates that the state is remembered for the duration of the request |
static int |
SESSION
When setting state this indicates that the state is remembered for the duration of the session |
static String |
STATE_MAXIMIZED
The state when the component has the entire page to itself |
static String |
STATE_MINIMIZED
The state when only the component title bar is showing |
static String |
STATE_NORMAL
The normal state of a component |
Method Summary | |
String |
getCallingPage()
Retrieves the url to the calling page. |
String |
getCallingPageQuery()
Retrieves the query paramter string from the calling page. |
Object |
getComponentContent()
Retrieves the markup set by the the Current component's getComponentData() method. |
String |
getComponentID()
Gets the current component being processed. |
EbiPortalComponentInfo |
getComponentInfo()
Returns the value object for the currently processed component. |
String |
getComponentInstanceName()
Returns the unique instance name of the current component. |
String |
getComponentMode()
Gets the current component's and instance's mode |
String |
getComponentState()
Gets the current component's and instance's state |
Document |
getComponentStyleDocument()
Retrieves the style document to be used when rendering the component, Assuming the component is XML. |
String |
getComponentStyleID()
Gets the style id of the style to be used to render this component. |
String |
getComponentTitle()
The title to be set in the title bar when the component is decorated |
boolean |
getComponentTitleBarEnabled()
Gets the title enabled setting. |
String |
getContentType()
Gets the content type of the content of EbiPortalContext.getComponentContent() |
String |
getContextName()
Gets the name of the context, which is used to namespace the calls to the underlying framework service factory. |
String |
getCurrentPID()
Gets the current Portal Page ID |
HttpServletRequest |
getHttpServletRequest()
Gets the HttpServletRequest associated with this context. |
HttpServletResponse |
getHttpServletResponse()
Gets the HttpServletResponse associated with this context. |
long |
getLastModified()
Deprecated. |
String |
getPageName()
Gets the currently viewed portal page name (shared or user page) The EbiPortalContext.getPageType() will indicate which type it is (shared or user) |
String |
getPageType()
Gets the type of the currently viewed portal page (shared or user) |
String |
getProfileName()
Deprecated. use EbiPortalContext#getUserPageName() |
boolean |
isComponentContentWellFormed()
Indicated whether or not the processed data from a component is well formed. |
boolean |
isPageWellFormed()
Indicated whether or not any of the data (from multiple components) on the page has malformed data (e.g. |
void |
reset()
Clears all current component information, setting it up for the next component. |
void |
setCallingPage(String url)
Set the current calling page URL. |
void |
setCallingPageQuery(String query)
Sets the calling page quesry parameter |
void |
setComponentContent(Object content)
This method is called by a component within the getComponentData() method. |
void |
setComponentContentWellFormed(boolean wellFormed)
Set whether or not the data from the component is well formed (e.g. |
void |
setComponentID(String compID)
Sets the current component being processes. |
void |
setComponentID(String componentID,
String instanceName)
Sets the current component to be processed by the presentation manager. |
void |
setComponentMode(String mode,
int level)
Sets the component mode for the current component |
void |
setComponentState(String state,
int level)
Sets the component state for the current component |
void |
setComponentStyleDocument(Document style)
Sets the style to be used by the component. |
void |
setComponentStyleID(String styleID)
Sets the style ID to be used when rendering the current component. |
void |
setComponentTitle(String title)
Sets the title to be displayed in the components title bar |
void |
setComponentTitle(String title,
int level)
Sets the title to be displayed in the components title bar |
void |
setComponentTitleBarEnabled(boolean enable)
Overrides the default setting of the component's title bar setting (enabled or not?) |
void |
setContentType(String type)
Specifies the content type of the content being set by EbiPortalContext.setComponentContent(Object) |
void |
setContextName(String contextName)
Sets the name of the context, which is used to namespace the calls to the underlying framework service factory. |
void |
setCurrentPID(String pidName)
Sets the current Portal Page ID |
void |
setLastModified(long miliseconds)
Deprecated. |
void |
setLastModifiedNow()
Deprecated. |
void |
setPageName(String pageName)
Sets the currently viewed page (Shared or User page) Should call EbiPortalContext.setPageType() to set the type of this page. |
void |
setPageType(String pageType)
Sets the page type of the current page (Shared or User) The page type can either be 'SHAREDPAGE' or 'USERPAGE' |
void |
setProfileName(String profileName)
Deprecated. use EbiPortalContext#setUserPageName() |
Methods implemented from interface com.sssw.fw.api.EbiRequestContext |
getCookieValue,
getResponsePhrase,
getResponseStatus,
getServletContext,
getURI,
hasQueryString,
setCookieValue,
setRequestResponse,
setResponsePhrase,
setResponseStatus,
setServletContext,
setURI |
Methods implemented from interface com.sssw.fw.api.EbiContext |
cloneCopy,
getAttributeNames,
getBrowserInfo,
getEbiRequest,
getEbiResponse,
getEbiSession,
getEbiSession,
getEbiWhiteboard,
getEJBContext,
getException,
getLocale,
getPrincipal,
getTemporaryData,
getTemporaryValue,
getValue,
getValue,
getValueNames,
hasSession,
hasValue,
isNewSession,
removeAllValues,
removeValue,
setEbiRequest,
setEbiResponse,
setEbiSession,
setEJBContext,
setException,
setTemporaryValue,
setValue |
Field Detail |
public static final int REQUEST
public static final int SESSION
public static final int PERSIST
public static final String STATE_NORMAL
public static final String STATE_MINIMIZED
public static final String STATE_MAXIMIZED
Method Detail |
public void reset()
public HttpServletRequest getHttpServletRequest()
public HttpServletResponse getHttpServletResponse()
public String getCallingPage()
The calling page reffers to a portal uri. This will not return a calling page to anotherapplication or server.
public void setCallingPage(String url)
url
- the url of the calling pagepublic String getCallingPageQuery()
public void setCallingPageQuery(String query)
query
- the query string of the calling pagepublic void setCurrentPID(String pidName)
pidName
- sets the currently viewd PIDpublic String getCurrentPID()
public String getProfileName()
EbiPortalContext#getUserPageName()
public void setProfileName(String profileName)
EbiPortalContext#setUserPageName()
profileName
- The name of the user pagepublic void setPageName(String pageName)
pageName
- The name of the user or shared pagepublic void setPageType(String pageType)
pageName
- The page typepublic String getPageName()
public String getPageType()
public long getLastModified()
public void setLastModified(long miliseconds)
miliseconds
- public void setLastModifiedNow()
public Object getComponentContent()
public void setComponentContent(Object content)
content
- The content returned byt the component is as a DOM or a String.
The return type is specified by EbiPortalContext.getContentType()
public void setComponentContentWellFormed(boolean wellFormed)
wellFormed
- Indicates if the data from the componetn is well formed (XML, XHTML, etc)public boolean isComponentContentWellFormed()
public boolean isPageWellFormed()
public void setComponentID(String compID)
compID
- public String getComponentID()
public void setComponentMode(String mode, int level)
the mode is set on the user's session with the componentID and instance name making up the key.
mode
- The name of the mode to be set on the session, if null the mode will be cleared from the associated levellevel
- Indicates at what level to store the mode.
example: setComponentMode("edit",EbiPortalContext.SESSION)
EbiPortalContext.REQUEST
,
EbiPortalContext.SESSION
,
EbiPortalContext.PERSIST
public String getComponentMode()
public void setComponentState(String state, int level)
the mode is set on the user's session with the componentID and instance name making up the key.
state
- The name of the state to be set on the sessionlevel
- Indicates at what levels to store the state the levels can be used in combination
example: setComponentState("minimized",EbiPortalContext.SESSION + EbiPortalContext.PERSIST
EbiPortalContext.REQUEST
,
EbiPortalContext.SESSION
,
EbiPortalContext.PERSIST
public String getComponentState()
public void setComponentID(String componentID, String instanceName)
componentID
- instanceName
- public EbiPortalComponentInfo getComponentInfo()
public void setComponentTitleBarEnabled(boolean enable)
enable
- public void setComponentTitle(String title, int level)
If this method is not called by the component then the display name, supplied in the descriptor, is used.
title
- level
- Indicates at what levels to persist the title.EbiPortalContext.REQUEST
,
EbiPortalContext.SESSION
,
EbiPortalContext.PERSIST
public void setComponentTitle(String title)
If this method is not called by the component then the display name, supplied in the descriptor, is used. This method is equivelant to calling setComponentTitle("Custom Title",EbiPortalContext.REQUEST)
title
- public boolean getComponentTitleBarEnabled()
public String getComponentTitle()
The title is retrieved in the follwoing order
public String getComponentStyleID()
public void setComponentStyleID(String styleID)
styleID
- The styleID of the style to be used to render the component.public String getComponentInstanceName()
public Document getComponentStyleDocument()
public void setComponentStyleDocument(Document style)
style
- the XSL style sheet in document format to be used when rendering the
XML componentpublic void setContentType(String type)
EbiPortalContext.setComponentContent(Object)
public String getContextName()
public void setContextName(String contextName)
contextName
- public String getContentType()
EbiPortalContext.getComponentContent()
|
Novell exteNd Director 5.2 API |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |