Package net.sf.basedb.clients.web.taglib
Class HideableSection
java.lang.Object
javax.servlet.jsp.tagext.TagSupport
net.sf.basedb.clients.web.taglib.StylableTag
net.sf.basedb.clients.web.taglib.HideableSection
- All Implemented Interfaces:
Serializable
,DynamicAttributes
,IterationTag
,JspTag
,Tag
,DynamicActionAttributes
This tag is used to display a section on a web page that
can be shown/hidden by the user by clicking on an icon
on it's title.
Example:
<%@ taglib prefix="base" uri="/WEB-INF/base.tld" %> <base:section id="my.section" title="Click to hide/show"> This is the contents of this section... </base:section>
Syntax:
<base:section id=... clazz=... showclazz=... hideclazz=... style=... contentstyle=... title=... visible=... ontoggle=... initial=show|hide context=... >
Attribute | Default value | Required | Description |
id | - | no | The ID of the section. The value of this attribute
goes directly into the standard id attribute.
This means that if you need a reference to the scetion object in your own
JavaScript code, you may for example use the following code:
|
clazz | note | no |
The value if this attribute goes directly into the standard HTML
class attribute both when the section contents is hidden or
visible.
|
showclazz | note | no |
The value if this attribute goes directly into the standard HTML
class attribute when the section contents is visible.
|
hideclazz | note | no |
The value if this attribute goes directly into the standard HTML
class attribute when the section contents is hidden.
|
style | - | no |
The value if this attribute goes directly into the standard HTML
style attribute. This allows you to apply different styles
to different sections.
|
contentstyle | - | no |
The value if this attribute goes directly into the standard HTML
style attribute of the content part. This allows you to apply different styles
to different sections.
|
title | no | The title of the section. | |
visible | true | no | If the section should be visible or not. |
initial | show | no |
If the value is hide the section is hidden, otherwise it
is visible. This setting is ignored if a context is given.
|
context | - | no |
An optional ItemContext object. If given the initial
atribute is ignored. The valus is instead taken from the context setting
section.id where id is replaced with the value of the
id attribute. This should have the value "1" to show the
section or "0" to hide the section. If a context is given the default
javascript method will also send an Ajax request to the web server which
will update the setting in the context with a new value for the
show/hide setting. Thus, all settings are remembered during a session
and also when the user returns to the next session.
|
- Version:
- 2.4
- Author:
- Nicklas
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionprivate String
Optionalstyle
attribute for the content sectionprivate ItemContext
private String
private Page
The parent <base:page> tag.private static final long
private String
private boolean
If the section should be shown or hidden to start with.private String
The title of the section.private boolean
If the section should be visible or not.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
getTitle()
boolean
void
setContentstyle
(String contentStyle) void
setContext
(ItemContext context) void
setHideclazz
(String clazz) void
setInitial
(String initial) void
setShowclazz
(String clazz) void
void
setVisible
(boolean visible) Methods inherited from class net.sf.basedb.clients.web.taglib.StylableTag
addDynamicAttributes, addIdAndStyles, getClazz, getDynamicActionAttributes, getDynamicAttribute, getFullClass, getIdPrefix, getStyle, getSubclass, initDefaultAttributes, resetDynamicAttributes, setClazz, setDynamicAttribute, setMoreDynamicAttributes, setPageContext, setStyle, setSubclass
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
The parent <base:page> tag. -
showClass
-
hideClass
-
contentStyle
Optionalstyle
attribute for the content section -
title
The title of the section. -
visible
private boolean visibleIf the section should be visible or not. -
showInitially
private boolean showInitiallyIf the section should be shown or hidden to start with. -
context
-
-
Constructor Details
-
HideableSection
public HideableSection()
-
-
Method Details
-
setShowclazz
-
getShowclazz
-
setHideclazz
-
getHideclazz
-
setContentstyle
-
getContentstyle
-
setTitle
-
getTitle
-
setVisible
public void setVisible(boolean visible) -
isVisible
public boolean isVisible() -
setInitial
-
getInitial
-
setContext
-
getContext
-
doStartTag
- Specified by:
doStartTag
in interfaceTag
- Overrides:
doStartTag
in classTagSupport
- Throws:
JspException
-
doEndTag
- Specified by:
doEndTag
in interfaceTag
- Overrides:
doEndTag
in classTagSupport
- Throws:
JspException
-