AdminPageletAdaptor¶
-
public class
AdminPageletAdaptor
extends BorderLayoutPageletAdaptor¶ AdminPageletAdaptor is an HTTP-XSLT pagelet adaptor. It generally serves as a main framework for the admin pages. Pages generated by this pagelet are in border layout format corresponding to the pre-defined template.
Subclasses are expected to override the getCenterSource() method and provide implementation for the generation of the transformation source which contributes to the center region of the page being rendered.
Author: Hugo Y. K. Lam
Fields¶
ATTR_MESSAGE¶
ATTR_PREFIX¶
store¶
-
public static final PageletStore
store
¶ The pagelet store of this pagelet.
Methods¶
getCenterSource¶
-
protected Source
getCenterSource
(HttpServletRequest request)¶ Gets the transformation source of the main body. This method by default generates a transformation source of the system status. Sub-classes should override this method and provide its own implementation.
Parameters: - request – the servlet request.
Returns: the transformation source of the system status.
See also:
hk.hku.cecid.piazza.commons.pagelet.xslt.BorderLayoutPageletAdaptor.getCenterSource(javax.servlet.http.HttpServletRequest)
getErrorSource¶
-
protected Source
getErrorSource
(TemplateElement element, Throwable e, HttpServletRequest request)¶ Gets transformation source which represents the error generated by any of the pagelets composing the page being generated by this pagelet.
See also:
hk.hku.cecid.piazza.commons.pagelet.xslt.HttpXsltPageletAdaptor.getErrorSource(TemplateElement,Throwable,HttpServletRequest)
getModuleId¶
-
protected String
getModuleId
(HttpServletRequest request)¶ Gets the module ID that this pagelet represents. This method will look up the listener parameter ‘module’.
Parameters: - request – the servlet request.
Returns: the module ID.
getNorthSource¶
-
protected Source
getNorthSource
(HttpServletRequest request)¶ Gets the transformation source of the menu tabs.
See also:
hk.hku.cecid.piazza.commons.pagelet.xslt.BorderLayoutPageletAdaptor.getNorthSource(javax.servlet.http.HttpServletRequest)
getPageletStore¶
-
protected PageletStore
getPageletStore
()¶
getSouthSource¶
-
protected Source
getSouthSource
(HttpServletRequest request)¶ Gets the transformation source of the message area. The source will be generated according to the message attribute.
Parameters: - request – the servlet request.
Returns: the transformation source of the message area.
See also:
.ATTR_MESSAGE
,hk.hku.cecid.piazza.commons.pagelet.xslt.BorderLayoutPageletAdaptor.getSouthSource(javax.servlet.http.HttpServletRequest)
getTabId¶
-
protected String
getTabId
(HttpServletRequest request)¶ Gets the tab ID that this pagelet represents. This method will look up the listener parameter ‘tab’.
Parameters: - request – the servlet request.
Returns: the tab ID.
getWestSource¶
-
protected Source
getWestSource
(HttpServletRequest request)¶ Gets the transformation source of the menu modules.
See also:
hk.hku.cecid.piazza.commons.pagelet.xslt.BorderLayoutPageletAdaptor.getWestSource(javax.servlet.http.HttpServletRequest)