de.must.markup

Class TabButtonGroupForJsp

java.lang.Object

de.must.markup.MustInputField

de.must.markup.TabButtonGroupForJsp

All Implemented Interfaces:

Markupable, ValueFetcher

public class TabButtonGroupForJsp
extends MustInputField

JTabbedPane equivalent for JSPs. Helps to divide large pages into multiple areas controlled by tab images. Needs

and <%= butler.HIDDEN_PANEL_FIELD %> in JSP What's specific to JSPs? It is not guaranteed that Butler and JSP grouping of input elements is synchronized. Therefore we do not assign input elements to tab areas at all. Thus, the butler will ask components to fetch their values from request which are not laid-out. They'll just keep their state. Butler snippets:

  ...
  tabButtonGroup = new TabButtonGroupForJsp(new String[] {"../../images/tab1_aktiv.gif", "../../images/tab2_aktiv.gif"}, new String[] {"../../images/tab1_inaktiv.gif", "../../images/tab2_inaktiv.gif"});
  ...
  protected void handle(GeneralizedRequest request) {
    tabButtonGroup.fetchYourValueFromRequest(request);
    storables.fetchValuesFromRequest(request);
    if (okButton.wasPressed()) {
      if (storables.inputCheckOk() && isInputAccepted()) {
        storables.save();
        goBack(); return;
      }
    } else if (cancelButton.wasPressed()) {
      goBack(); return;
    } else if (tabButtonGroup.wasUsed()) {
      // nothing to do - and don't reload, we want to keep user input!
      return;
    } else {
      String idString = request.getParameter("ID");
      if (idString != null) {
        storables.loadValues(Integer.parseInt(idString));
      } else {
        storables.newInput();
      }
    }
  }
  ...
 

and JSP snippet:

 
    
    
    <%switch (butler.tabButtonGroup.getSelectedIndex()) { case 0: %>
    
    <%break; case 1:%>
    
    <%}%>
    

    

    
<%=butler.tabButtonGroup%>
    

    
Field 1:
<%=butler.field1%>
    

    
Field 2:
<%=butler.field2%>
    

    
Field 3:
<%=butler.field3%%>
    

    
Field 4:
<%=butler.field4%%>
    
    
<%=butler.okButton%> <%=butler.cancelButton%>
    <%= butler.HIDDEN_PANEL_FIELD %>
    
 

Field Summary

Fields inherited from class de.must.markup.MustInputField

comment, focus, name, placeholder, toolTipText

Constructor Summary

Constructors

Constructor and Description
TabButtonGroupForJsp(java.lang.String[] unanimatedTabImages) Constructs a simple new tab button group without different images for active and inactive state.
TabButtonGroupForJsp(java.lang.String[] activeTabImages, java.lang.String[] inactiveTabImages) Constructs a new tab button group with different images for active in inactive state.

Method Summary

Modifier and Type	Method and Description
void	destroy() Destroys the markupable.
void	fetchYourValueFromRequest(GeneralizedRequest request) Causes the component to read user input by calling request.getParameter and update the internal mirrored value.
java.lang.String	getCreationTag() Returns the tag sequence that's needed to show this object in the user interface.
int	getSelectedIndex() Returns the selected index.
void	setSelectedIndex(int selectedIndex) Sets the selected Index.
void	setToolTipText(int index, java.lang.String newToolTipText) Sets a tool tip text for tab icon as specified.
void	setToolTipText(java.lang.String newToolTipText) Sets the component's tool tip text.
boolean	wasUsed() Returns true if user input was switching to any other tabbed pane.

Methods inherited from class de.must.markup.MustInputField

getName, setComment, setFocus, setPlaceHolder, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TabButtonGroupForJsp

public TabButtonGroupForJsp(java.lang.String[] unanimatedTabImages)

Constructs a simple new tab button group without different images for active and inactive state.

Parameters:

unanimatedTabImages - array of images to be used when item become active

TabButtonGroupForJsp

public TabButtonGroupForJsp(java.lang.String[] activeTabImages,
                            java.lang.String[] inactiveTabImages)

Constructs a new tab button group with different images for active in inactive state.

Parameters:

activeTabImages - array of images to be used when item become active

inactiveTabImages - array of images to be used when item are inactive

Method Detail

setToolTipText

public void setToolTipText(java.lang.String newToolTipText)

Description copied from class: MustInputField

Sets the component's tool tip text.

Specified by:

setToolTipText in interface Markupable

Overrides:

setToolTipText in class MustInputField

Parameters:

newToolTipText - the component's tool tip text

setToolTipText

public void setToolTipText(int index,
                           java.lang.String newToolTipText)

Sets a tool tip text for tab icon as specified.

Parameters:

index - the index of the tab to be described

newToolTipText - the new tool tip text for the tab

setSelectedIndex

public void setSelectedIndex(int selectedIndex)

Sets the selected Index.

Parameters:

selectedIndex - the new index to select

getSelectedIndex

public int getSelectedIndex()

Returns the selected index.

Returns:

the selected index

getCreationTag

public java.lang.String getCreationTag()

Description copied from interface: Markupable

Returns the tag sequence that's needed to show this object in the user interface. At the moment, HTML is supported.

Returns:

the tag sequence to show the component

fetchYourValueFromRequest

public void fetchYourValueFromRequest(GeneralizedRequest request)

Description copied from interface: ValueFetcher

Causes the component to read user input by calling request.getParameter and update the internal mirrored value.

Specified by:

fetchYourValueFromRequest in interface ValueFetcher

Specified by:

fetchYourValueFromRequest in class MustInputField

Parameters:

request - the current request

wasUsed

public boolean wasUsed()

Returns true if user input was switching to any other tabbed pane. In this case we must not reload form data because we want to keep user input.

Returns:

true if user input was switching to any other tabbed pane

destroy

public void destroy()

Description copied from interface: Markupable

Destroys the markupable. Useful to release e.g. static references which prevent the garbage collector from finalizing. For example HalfDataComboBoxes add s as Listeners to database changes. These listeners are registered statically. Thus, these listeners cannot be removed by the garbage collector, they have to be removed manually. This may be done by calling this destroy method.

Specified by:

destroy in interface Markupable

Overrides:

destroy in class MustInputField