MainComponent.java

package org.jtheque.views.components;

/*
 * Copyright JTheque (Baptiste Wicht)
 *
 * 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.
 */

import javax.swing.JComponent;

/**
 * A main component. This kind of component can be added to the main view. If there is only one main component, it will
 * be displayed normally else it will displayed inside a tabbed pane.
 *
 * @author Baptiste Wicht
 */
public interface MainComponent {
    /**
     * Return the component implement.
     *
     * @return The component.
     */
    JComponent getImpl();

    /**
     * Return the position of the tab component. This method is not used if there is only one main component.
     *
     * @return An Integer representing the position of the tab component.
     */
    int getPosition();

    /**
     * Return the title key of the tab component. This method is not used if there is only one main component.
     *
     * @return The internationalization key.
     */
    String getTitleKey();
}