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
public class HideableSection
extends StylableTag
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=...
   >
Tag attributes
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:

section = document.getElementById('<id>');

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:
Serialized Form

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:
      Constant Field Values

    • page

      private Page page
      The parent <base:page> tag.

    • showClass

      private String showClass

    • hideClass

      private String hideClass

    • contentStyle

      private String contentStyle
      Optional style attribute for the content section

    • title

      private String title
      The title of the section.

    • visible

      private boolean visible
      If the section should be visible or not.

    • showInitially

      private boolean showInitially
      If the section should be shown or hidden to start with.

    • context

      private transient ItemContext context

  • Constructor Details

    • HideableSection

      public HideableSection()

  • Method Details

    • setShowclazz

      public void setShowclazz​(String clazz)

    • getShowclazz

      public String getShowclazz()

    • setHideclazz

      public void setHideclazz​(String clazz)

    • getHideclazz

      public String getHideclazz()

    • setContentstyle

      public void setContentstyle​(String contentStyle)

    • getContentstyle

      public String getContentstyle()

    • setTitle

      public void setTitle​(String title)

    • getTitle

      public String getTitle()

    • setVisible

      public void setVisible​(boolean visible)

    • isVisible

      public boolean isVisible()

    • setInitial

      public void setInitial​(String initial)

    • getInitial

      public String getInitial()

    • setContext

      public void setContext​(ItemContext context)

    • getContext

      public ItemContext getContext()

    • doStartTag

      public int doStartTag() throws JspException
      Specified by:
      doStartTag in interface Tag
      Overrides:
      doStartTag in class TagSupport
      Throws:
      JspException

    • doEndTag

      public int doEndTag() throws JspException
      Specified by:
      doEndTag in interface Tag
      Overrides:
      doEndTag in class TagSupport
      Throws:
      JspException