Package net.sf.basedb.clients.web.taglib
Class Page
java.lang.Object
javax.servlet.jsp.tagext.TagSupport
net.sf.basedb.clients.web.taglib.Page
- All Implemented Interfaces:
Serializable
,IterationTag
,JspTag
,Tag
This tag should be used together with the
<base:head>
and
<base:body>
tags on every JSP page in BASE.
Example:
<%@ taglib prefix="base" uri="/WEB-INF/base.tld" %> <base:page type="default" title="Welcome to BASE"> <base:head> <!-- scripts and other head things... --> </base:head> <base:body> Page contents go here.... </base:body> </base:page>
Syntax:
<base:page type=default|popup|include title=... menu=... doctype=... >
Attribute | Default value | Required | Description |
type | default | no | The type of the page. Three values are defined:
|
title | - | yes | The title of the page. |
menu | auto | no |
The name of the menu to use on the page. This value is only used
for pages with type=default. See the /include/menu.jsp
file for defined menu names.
|
doctype | html | no | The doctype to use in the generated html page. The default is html which is the new HTML5 doctype. Use HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd" to get the older HTML 4 doctype. |
favicon | favicon.ico | no | The 'favicon' to use. |
- Version:
- 2.0
- Author:
- Nicklas
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionprivate static String
The version of BASE.private static String
The default page title.private String
The <!private String
The 'favicon' to use.private static boolean
private static String
private String
The name of the menu that should be displayed on the current page.private boolean
Set to TRUE to not use skin on the page.(package private) static final int
This is the default page type.(package private) static final int
The page is in a separate iframe .(package private) static final int
This page is an included page.(package private) static final int
The page is a popup dialouge.private static String
The path to the root directory of this webserver.private SessionControl
The SessionControl object in use for this request.private boolean
private static final long
private static String
The name of this webserver.private List<SkinAction>
private JspContext
private String
The title of the page.private int
The type of the current page.Fields inherited from class javax.servlet.jsp.tagext.TagSupport
id, pageContext
Fields inherited from interface javax.servlet.jsp.tagext.IterationTag
EVAL_BODY_AGAIN
Fields inherited from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionint
doEndTag()
int
getMenu()
boolean
getRoot()
Get all skin extension actions.Get the JSP context used for invoking skin extensions.getTitle()
int
private static void
initStaticFields
(PageContext pageContext) Initialize static fields.static String
ROOT()
Static version ofgetRoot()
.void
setDoctype
(String doctype) void
setFavicon
(String favicon) void
void
setNoskin
(boolean noSkin) Set to TRUE to disable skins.void
setPageContext
(PageContext pageContext) void
setSc
(SessionControl sc) Set the session control to use in this request.void
void
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setParent, setValue
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
PAGE_TYPE_DEFAULT
static final int PAGE_TYPE_DEFAULTThis is the default page type.- See Also:
-
PAGE_TYPE_POPUP
static final int PAGE_TYPE_POPUPThe page is a popup dialouge.- See Also:
-
PAGE_TYPE_INCLUDE
static final int PAGE_TYPE_INCLUDEThis page is an included page.- See Also:
-
PAGE_TYPE_IFRAME
static final int PAGE_TYPE_IFRAMEThe page is in a separate iframe .- Since:
- 3.1
- See Also:
-
title
The title of the page. -
noSkin
private boolean noSkinSet to TRUE to not use skin on the page.- Since:
- 3.4
-
doctype
The <!doctype xxx> setting. -
type
private int typeThe type of the current page. -
favicon
The 'favicon' to use. -
initialized
private static volatile boolean initialized -
SERVER_NAME
The name of this webserver. -
ROOT
The path to the root directory of this webserver. -
BASE_VERSION
The version of BASE. -
DEFAULT_PAGE_TITLE
The default page title.- Since:
- 3.12
-
MAX_URL_LENGTH
-
sc
The SessionControl object in use for this request. -
scHasBeenSet
private transient boolean scHasBeenSet -
skinContext
-
skinActions
-
-
Constructor Details
-
Page
public Page()
-
-
Method Details
-
ROOT
Static version ofgetRoot()
.- Since:
- 3.5
-
initStaticFields
Initialize static fields.- Since:
- 2.16
-
setMenu
-
getMenu
-
setTitle
-
getTitle
-
setNoskin
public void setNoskin(boolean noSkin) Set to TRUE to disable skins.- Since:
- 3.4
-
getNoSkin
public boolean getNoSkin() -
setSc
Set the session control to use in this request.- Since:
- 3.10
-
getSessionControl
-
setType
-
getTypeCode
public int getTypeCode() -
setDoctype
-
getDoctype
-
setFavicon
- Since:
- 3.3.1
-
getFavicon
-
getRoot
-
getMaxUrlLength
- Since:
- 2.8
-
getServerName
-
getBaseVersion
-
getSkinContext
Get the JSP context used for invoking skin extensions. Needed by HEAD taglib so that it can include required scripts and stylesheets.- Since:
- 3.4
-
getSkinActions
Get all skin extension actions. Needed in BODY so that it can include data on the page.- Since:
- 3.4
-
setPageContext
- Specified by:
setPageContext
in interfaceTag
- Overrides:
setPageContext
in classTagSupport
-
doStartTag
- Specified by:
doStartTag
in interfaceTag
- Overrides:
doStartTag
in classTagSupport
- Throws:
JspException
-
doEndTag
- Specified by:
doEndTag
in interfaceTag
- Overrides:
doEndTag
in classTagSupport
- Throws:
JspException
-