pt.digitalis.dif.presentation.views.jsp.taglibs.layout.panels
Class Panel

java.lang.Object
  extended by javax.servlet.jsp.tagext.TagSupport
      extended by javax.servlet.jsp.tagext.BodyTagSupport
          extended by pt.digitalis.dif.presentation.views.jsp.taglibs.AbstractDIFTag
              extended by pt.digitalis.dif.presentation.views.jsp.taglibs.AbstractInnerDIFTag
                  extended by pt.digitalis.dif.presentation.views.jsp.taglibs.layout.panels.Panel
All Implemented Interfaces:
java.io.Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag, IFootnoteContainer, IPanelContainer, ITagExecutionContext

public class Panel
extends AbstractInnerDIFTag
implements IFootnoteContainer, IPanelContainer

Accordion interface

Author:
Pedro Viegas pviegas@digitalis.pt
See Also:
Serialized Form
Created on:
Feb 22, 2008

Field Summary
 
Fields inherited from class pt.digitalis.dif.presentation.views.jsp.taglibs.AbstractDIFTag
DOCUMENT_ID, DOCUMENT_SECURITY_TOKEN, MAIN_RESPONSE_ID, PAGE_CONTENT_ATTRIBUTE
 
Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport
bodyContent
 
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
pageContext
 
Fields inherited from interface javax.servlet.jsp.tagext.BodyTag
EVAL_BODY_BUFFERED, EVAL_BODY_TAG
 
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
Panel()
           
 
Method Summary
 void addFootnote(FootnoteBean footnote)
          Adds a new footnote to the container.
 void addFootnotes(java.util.List<FootnoteBean> footnotes)
          Adds new footnotes to the container.
 void addPanel(PanelDefinition panel)
          Adds a panel to the list
protected  void cleanUp()
          Cleans the attributes for tag reuse
 void clearAllFootnotes()
          Clears the container footnotes.
 boolean containsFootnote(java.lang.String id)
          Checks if the container has already a footnote with the supplied id.
 int doEndTag()
           
 int doStartTag()
           
 PanelAlignment getAlign()
          Inspector for the 'align' attribute.
 java.lang.Boolean getBorder()
          Inspector for the 'border' attribute.
 java.lang.Boolean getCollapsed()
          Inspector for the 'collapsed' attribute.
 java.lang.Boolean getCollapsible()
          Inspector for the 'collapsible' attribute.
 java.lang.String getDescription()
          Inspector for the 'description' attribute.
 FootnoteBean getFootnote(java.lang.String id)
          Returns the footnote with the supplied id.
 int getFootnoteSequenceNumber()
          Returns the next footnote sequence number.
 java.util.List<FootnoteBean> getFootnotesList()
          Returns the list of footnotes.
 java.lang.Integer getHeight()
          Inspector for the 'height' attribute.
 java.lang.String getId()
           
 PageContainer getPageContainerTag()
           
 PanelContainerDefinition getPanelContainerDefinition()
           
 IPanelContainer getPanelContainerTag()
           
 java.lang.Boolean getSplit()
          Inspector for the 'split' attribute.
 java.lang.String getTitle()
           
 java.lang.String getWidth()
          Inspector for the 'width' attribute.
 Wizard getWizardContainerTag()
           
 boolean hasFootnotes()
           
 boolean isAccessible()
          Inspector for the 'accessible' attribute.
 boolean isEnabled()
          Inspector for the 'enabled' attribute.
 boolean isInsidePageContainer()
           
 boolean isInsidePanelContainer()
           
 boolean isInsideWizard()
           
 void setAccessible(boolean accessible)
          Modifier for the 'accessible' attribute.
 void setAlign(PanelAlignment align)
          Modifier for the 'align' attribute.
 void setBorder(java.lang.Boolean border)
          Modifier for the 'border' attribute.
 void setCollapsed(java.lang.Boolean collapsed)
          Modifier for the 'collapsed' attribute.
 void setCollapsible(java.lang.Boolean collapsible)
          Modifier for the 'collapsible' attribute.
 void setDescription(java.lang.String description)
          Modifier for the 'description' attribute.
 void setEnabled(boolean enabled)
          Modifier for the 'enabled' attribute.
 void setHeight(java.lang.Integer height)
          Modifier for the 'height' attribute.
 void setId(java.lang.String id)
           
 void setSplit(java.lang.Boolean split)
          Modifier for the 'split' attribute.
 void setTitle(java.lang.String title)
           
 void setWidth(java.lang.String width)
          Modifier for the 'width' attribute.
 PanelDefinition toPanelDefinition()
           
 
Methods inherited from class pt.digitalis.dif.presentation.views.jsp.taglibs.AbstractInnerDIFTag
addHelpItem, bufferInnerContributions, flushContributions, flushContributions, flushContributions, getApplicationID, getComponentGeneratedId, getContributions, getDocumentTag, getLanguage, getLoggedProfileID, getLoggedProfileName, getLoggedUserFullName, getLoggedUserGroupIDs, getLoggedUsername, getMainDocumentTag, getMainRequestedStageID, getParentFootnoteContainerTag, getServiceID, getStageID, getTabIndexAttribute, getTabIndexAttribute, getTabIndexNumber, hasAccessToStage, hasAccessToStage, isLogged
 
Methods inherited from class pt.digitalis.dif.presentation.views.jsp.taglibs.AbstractDIFTag
getAuthorizationManager, getConfigurations, getDemManager, getDIFRequest, getDIFResponse, getDIFSession, getHttpControllerConfig, getIdentityManager, getMainRequest, getMainResponse, getMessageManager, getParameter, getParameterValueAsBoolean, getParameterValueAsString, getResponseBeanValue, getSecurityToken, getSessionManager, getStageInstance, getStageLink, getStageLink, getStageLinkURL, getStageLinkWithParameters, getTagMessage, getTagMessages, getTagMessages, getTagMessages, getUILevel, getWebUIHTMLGenerator, getWebUIJavascriptProvider, getWebUIStyleProvider, isAjaxMode, isComponentMode, isHelpMode, isPopupMode, isTemplateMode, setDIFResponse
 
Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport
doAfterBody, doInitBody, getBodyContent, getPreviousOut, release, setBodyContent
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
findAncestorWithClass, getParent, getValue, getValues, removeValue, setPageContext, setParent, setValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface pt.digitalis.dif.presentation.views.jsp.taglibs.interfaces.ITagExecutionContext
getSecurityToken, getTagMessage, getTagMessages, getUILevel, isAjaxMode, isComponentMode, isHelpMode, isPopupMode, isTemplateMode
 
Methods inherited from interface javax.servlet.jsp.tagext.Tag
getParent, setPageContext, setParent
 

Constructor Detail

Panel

public Panel()
Method Detail

addFootnote

public void addFootnote(FootnoteBean footnote)
Description copied from interface: IFootnoteContainer
Adds a new footnote to the container.

Specified by:
addFootnote in interface IFootnoteContainer
Parameters:
footnote - the footnote to add
See Also:
IFootnoteContainer.addFootnote(pt.digitalis.dif.presentation.views.jsp.taglibs.objects.beans.FootnoteBean)

addFootnotes

public void addFootnotes(java.util.List<FootnoteBean> footnotes)
Description copied from interface: IFootnoteContainer
Adds new footnotes to the container.

Specified by:
addFootnotes in interface IFootnoteContainer
Parameters:
footnotes - the footnotes to add
See Also:
IFootnoteContainer.addFootnotes(java.util.List)

addPanel

public void addPanel(PanelDefinition panel)
Description copied from interface: IPanelContainer
Adds a panel to the list

Specified by:
addPanel in interface IPanelContainer
See Also:
IPanelContainer.addPanel(pt.digitalis.dif.presentation.views.jsp.taglibs.objects.beans.panels.PanelDefinition)

cleanUp

protected void cleanUp()
Cleans the attributes for tag reuse


clearAllFootnotes

public void clearAllFootnotes()
Description copied from interface: IFootnoteContainer
Clears the container footnotes.

Specified by:
clearAllFootnotes in interface IFootnoteContainer
See Also:
IFootnoteContainer.clearAllFootnotes()

containsFootnote

public boolean containsFootnote(java.lang.String id)
Description copied from interface: IFootnoteContainer
Checks if the container has already a footnote with the supplied id.

Specified by:
containsFootnote in interface IFootnoteContainer
Parameters:
id - the footnote id
Returns:
T if the container already contains the footnote, F otherwise
See Also:
IFootnoteContainer.containsFootnote(java.lang.String)

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException
Specified by:
doEndTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doEndTag in class javax.servlet.jsp.tagext.BodyTagSupport
Throws:
javax.servlet.jsp.JspException
See Also:
BodyTagSupport.doEndTag()

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException
Specified by:
doStartTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doStartTag in class javax.servlet.jsp.tagext.BodyTagSupport
Throws:
javax.servlet.jsp.JspException
See Also:
BodyTagSupport.doStartTag()

getAlign

public PanelAlignment getAlign()
Inspector for the 'align' attribute.

Returns:
the align value

getBorder

public java.lang.Boolean getBorder()
Inspector for the 'border' attribute.

Returns:
the border value

getCollapsed

public java.lang.Boolean getCollapsed()
Inspector for the 'collapsed' attribute.

Returns:
the collapsed value

getCollapsible

public java.lang.Boolean getCollapsible()
Inspector for the 'collapsible' attribute.

Returns:
the collapsible value

getDescription

public java.lang.String getDescription()
Inspector for the 'description' attribute.

Returns:
the description value

getFootnote

public FootnoteBean getFootnote(java.lang.String id)
Description copied from interface: IFootnoteContainer
Returns the footnote with the supplied id.

Specified by:
getFootnote in interface IFootnoteContainer
Parameters:
id - the footnote id
Returns:
the footnote if it exists, null otherwise
See Also:
IFootnoteContainer.getFootnote(java.lang.String)

getFootnoteSequenceNumber

public int getFootnoteSequenceNumber()
Description copied from interface: IFootnoteContainer
Returns the next footnote sequence number.

Specified by:
getFootnoteSequenceNumber in interface IFootnoteContainer
Returns:
the next footnote sequence number.
See Also:
IFootnoteContainer.getFootnoteSequenceNumber()

getFootnotesList

public java.util.List<FootnoteBean> getFootnotesList()
Description copied from interface: IFootnoteContainer
Returns the list of footnotes.

Specified by:
getFootnotesList in interface IFootnoteContainer
Returns:
the list of footnotes
See Also:
IFootnoteContainer.getFootnotesList()

getHeight

public java.lang.Integer getHeight()
Inspector for the 'height' attribute.

Returns:
the height value

getId

public java.lang.String getId()
Specified by:
getId in interface ITagExecutionContext
Overrides:
getId in class javax.servlet.jsp.tagext.TagSupport
Returns:
the id

getPageContainerTag

public PageContainer getPageContainerTag()
Returns:
the outer page container tag object

getPanelContainerDefinition

public PanelContainerDefinition getPanelContainerDefinition()
Specified by:
getPanelContainerDefinition in interface IPanelContainer
Returns:
the panels
See Also:
IPanelContainer.getPanelContainerDefinition()

getPanelContainerTag

public IPanelContainer getPanelContainerTag()
Returns:
the outer panel container tag object

getSplit

public java.lang.Boolean getSplit()
Inspector for the 'split' attribute.

Returns:
the split value

getTitle

public java.lang.String getTitle()
Returns:
the title

getWidth

public java.lang.String getWidth()
Inspector for the 'width' attribute.

Returns:
the width value

getWizardContainerTag

public Wizard getWizardContainerTag()
Returns:
the outer wizard container tag object

hasFootnotes

public boolean hasFootnotes()
Specified by:
hasFootnotes in interface IFootnoteContainer
Returns:
T if there are footnotes stored
See Also:
IFootnoteContainer.hasFootnotes()

isAccessible

public boolean isAccessible()
Inspector for the 'accessible' attribute.

Returns:
the accessible value

isEnabled

public boolean isEnabled()
Inspector for the 'enabled' attribute.

Returns:
the enabled value

isInsidePageContainer

public boolean isInsidePageContainer()
Returns:
T if this item is inside an PageContainer tag, F otherwise

isInsidePanelContainer

public boolean isInsidePanelContainer()
Returns:
T if this item is inside an AbstractPanelContainer tag, F otherwise

isInsideWizard

public boolean isInsideWizard()
Returns:
T if this item is inside a Wizard tag, F otherwise

setAccessible

public void setAccessible(boolean accessible)
Modifier for the 'accessible' attribute.

Parameters:
accessible - the new accessible value to set

setAlign

public void setAlign(PanelAlignment align)
Modifier for the 'align' attribute.

Parameters:
align - the new align value to set

setBorder

public void setBorder(java.lang.Boolean border)
Modifier for the 'border' attribute.

Parameters:
border - the new border value to set

setCollapsed

public void setCollapsed(java.lang.Boolean collapsed)
Modifier for the 'collapsed' attribute.

Parameters:
collapsed - the new collapsed value to set

setCollapsible

public void setCollapsible(java.lang.Boolean collapsible)
Modifier for the 'collapsible' attribute.

Parameters:
collapsible - the new collapsible value to set

setDescription

public void setDescription(java.lang.String description)
Modifier for the 'description' attribute.

Parameters:
description - the new description value to set

setEnabled

public void setEnabled(boolean enabled)
Modifier for the 'enabled' attribute.

Parameters:
enabled - the new enabled value to set

setHeight

public void setHeight(java.lang.Integer height)
Modifier for the 'height' attribute.

Parameters:
height - the new height value to set

setId

public void setId(java.lang.String id)
Overrides:
setId in class javax.servlet.jsp.tagext.TagSupport
Parameters:
id - the id to set

setSplit

public void setSplit(java.lang.Boolean split)
Modifier for the 'split' attribute.

Parameters:
split - the new split value to set

setTitle

public void setTitle(java.lang.String title)
Parameters:
title - the title to set

setWidth

public void setWidth(java.lang.String width)
Modifier for the 'width' attribute.

Parameters:
width - the new width value to set

toPanelDefinition

public PanelDefinition toPanelDefinition()
Returns:
the current panel as a PanelDefinition object


Copyright © 2011 Digitalis Informática Lda. All Rights Reserved.