wicket.extensions.markup.html.tabs.TabbedPanel Maven / Gradle / Ivy
/*
* $Id: TabbedPanel.java 4079 2006-02-02 10:18:54 -0800 (Thu, 02 Feb 2006)
* ivaynberg $ $Revision: 462413 $ $Date: 2006-02-02 10:18:54 -0800 (Thu, 02 Feb
* 2006) $
*
* ==================================================================== Licensed
* under the Apache License, Version 2.0 (the "License"); you may not use this
* file except in compliance with the License. You may obtain a copy of the
* License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
package wicket.extensions.markup.html.tabs;
import java.util.List;
import wicket.Component;
import wicket.WicketRuntimeException;
import wicket.behavior.AttributeAppender;
import wicket.behavior.SimpleAttributeModifier;
import wicket.markup.html.WebMarkupContainer;
import wicket.markup.html.basic.Label;
import wicket.markup.html.link.Link;
import wicket.markup.html.list.Loop;
import wicket.markup.html.panel.Panel;
import wicket.model.AbstractReadOnlyModel;
import wicket.model.IModel;
import wicket.model.Model;
/**
* TabbedPanel component represets a panel with tabs that are used to switch
* between different content panels inside the TabbedPanel panel.
*
* Example:
*
*
*
* List tabs=new ArrayList();
*
* tabs.add(new AbstractTab(new Model("first tab")) {
*
* public Panel getPanel(String panelId)
* {
* return new TabPanel1(panelId);
* }
*
* });
*
* tabs.add(new AbstractTab(new Model("second tab")) {
*
* public Panel getPanel(String panelId)
* {
* return new TabPanel2(panelId);
* }
*
* });
*
* add(new TabbedPanel("tabs", tabs);
*
*
* <span wicket:id="tabs" class="tabpanel">[tabbed panel will be here]</span>
*
*
*
*
*
*
* For a complete example see the component references in wicket-examples
* project
*
*
* @see wicket.extensions.markup.html.tabs.ITab
*
* @author Igor Vaynberg (ivaynberg)
*
*/
public class TabbedPanel extends Panel
{
private static final long serialVersionUID = 1L;
/**
* id used for child panels
*/
public static final String TAB_PANEL_ID = "panel";
private List tabs;
/**
* Constructor
*
* @param id
* component id
* @param tabs
* list of ITab objects used to represent tabs
*/
public TabbedPanel(String id, List tabs)
{
super(id, new Model(new Integer(-1)));
if (tabs == null)
{
throw new IllegalArgumentException("argument [tabs] cannot be null");
}
if (tabs.size() < 1)
{
throw new IllegalArgumentException(
"argument [tabs] must contain a list of at least one tab");
}
this.tabs = tabs;
final IModel tabCount = new AbstractReadOnlyModel()
{
private static final long serialVersionUID = 1L;
public Object getObject(Component component)
{
return new Integer(TabbedPanel.this.tabs.size());
}
};
// add the loop used to generate tab names
add(new Loop("tabs", tabCount)
{
private static final long serialVersionUID = 1L;
protected void populateItem(LoopItem item)
{
final int index = item.getIteration();
final ITab tab = ((ITab)TabbedPanel.this.tabs.get(index));
final int selected = getSelectedTab();
final WebMarkupContainer titleLink = newLink("link", index);
titleLink.add(new Label("title", tab.getTitle()));
item.add(titleLink);
item.add(new SimpleAttributeModifier("class", "selected")
{
private static final long serialVersionUID = 1L;
public boolean isEnabled()
{
return index == selected;
}
});
if (item.getIteration() == getIterations() - 1)
{
item.add(new AttributeAppender("class", true, new Model("last"), " "));
}
}
});
// select the first tab by default
setSelectedTab(0);
}
/**
* @return list of tabs that can be used by the user to add/remove/reorder
* tabs in the panel
*/
public final List getTabs()
{
return tabs;
}
/**
* Factory method for links used to switch between tabs.
*
* The created component is attached to the following markup. Label
* component with id: title will be added for you by the tabbed panel.
*
*
* <a href="#" wicket:id="link"><span wicket:id="title">[[tab title]]</span></a>
*
*
* Example implementation:
*
*
* protected WebMarkupContainer newLink(String linkId, final int index)
* {
* return new Link(linkId)
* {
* private static final long serialVersionUID = 1L;
*
* public void onClick()
* {
* setSelectedTab(index);
* }
* };
* }
*
*
* @param linkId
* component id with which the link should be created
* @param index
* index of the tab that should be activated when this link is
* clicked. See {@link #setSelectedTab(int)}.
* @return created link component
*/
protected WebMarkupContainer newLink(String linkId, final int index)
{
return new Link(linkId)
{
private static final long serialVersionUID = 1L;
public void onClick()
{
setSelectedTab(index);
}
};
}
/**
* sets the selected tab
*
* @param index
* index of the tab to select
*
*/
public final void setSelectedTab(int index)
{
if (index < 0 || index >= tabs.size())
{
throw new IndexOutOfBoundsException();
}
setModelObject(new Integer(index));
ITab tab = (ITab)tabs.get(index);
Panel panel = tab.getPanel(TAB_PANEL_ID);
if (panel == null)
{
throw new WicketRuntimeException("ITab.getPanel() returned null. TabbedPanel ["
+ getPath() + "] ITab index [" + index + "]");
}
if (!panel.getId().equals(TAB_PANEL_ID))
{
throw new WicketRuntimeException(
"ITab.getPanel() returned a panel with invalid id ["
+ panel.getId()
+ "]. You must always return a panel with id equal to the provided panelId parameter. TabbedPanel ["
+ getPath() + "] ITab index [" + index + "]");
}
if (get(TAB_PANEL_ID) == null)
{
add(panel);
}
else
{
replace(panel);
}
}
/**
* @return index of the selected tab
*/
public final int getSelectedTab()
{
return ((Integer)getModelObject()).intValue();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy