001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.wicket.extensions.markup.html.tabs;
018
019import org.apache.wicket.markup.html.WebMarkupContainer;
020import org.apache.wicket.model.IModel;
021import org.apache.wicket.util.io.IClusterable;
022
023/**
024 * Interface used to represent a single tab in a TabbedPanel
025 * 
026 * @see org.apache.wicket.extensions.markup.html.tabs.TabbedPanel
027 * @see org.apache.wicket.extensions.markup.html.tabs.AbstractTab
028 * 
029 * @author Igor Vaynberg (ivaynberg)
030 */
031public interface ITab extends IClusterable
032{
033        /**
034         * @return IModel used to represent the title of the tab. Must contain a string.
035         */
036        IModel<String> getTitle();
037
038        /**
039         * @param containerId
040         *            returned panel MUST have this id
041         * @return a container object (e.g. Panel or Fragment) that will be placed as the content of the
042         *         tab
043         */
044        WebMarkupContainer getPanel(final String containerId);
045
046        /**
047         * Returns whether this tab should be visible
048         * 
049         * @return whether this tab should be visible
050         */
051        boolean isVisible();
052}