001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: *//*
041: * TabLayoutModel.java
042: *
043: * Created on May 16, 2003, 3:47 PM
044: */
045:
046: package org.netbeans.swing.tabcontrol.plaf;
047:
048: import java.awt.*;
049:
050: /**
051: * A model representing the visual layout of tabs in a TabDataModel as a set of
052: * rectangles. Used by BasicTabDisplayerUI and its subclasses to manage the layout of
053: * tabs in the displayer.
054: *
055: * @author Tim Boudreau
056: */
057: public interface TabLayoutModel {
058: /**
059: * Get the x coordinate of the tab rectangle for the tab at index
060: * <code>index</code> in the data model.
061: *
062: * @param index The tab index
063: * @return The coordinate
064: */
065: public int getX(int index);
066:
067: /**
068: * Get the y coordinate of the tab rectangle for the tab at index
069: * <code>index</code> in the data model.
070: *
071: * @param index The tab index
072: * @return The coordinate
073: */
074: public int getY(int index);
075:
076: /**
077: * Get the width of the tab rectangle for the tab at index
078: * <code>index</code> in the data model.
079: *
080: * @param index The tab index
081: * @return The width
082: */
083: public int getW(int index);
084:
085: /**
086: * Get the height of the tab rectangle for the tab at index
087: * <code>index</code> in the data model.
088: *
089: * @param index The tab index
090: * @return The height
091: */
092: public int getH(int index);
093:
094: /**
095: * Get the index of the tab in the data model for the supplied point.
096: *
097: * @param x X coordinate of a point representing a set of pixel coordinate in the space
098: * modeled by this layout model
099: * @param y Y coordinate
100: * @return The index into the data model of the tab displayed at the passed
101: * point or -1
102: */
103: public int indexOfPoint(int x, int y);
104:
105: // XXX DnD only
106: /**
107: * Gets the index of possibly dropped component (as a new tab).
108: */
109: public int dropIndexOfPoint(int x, int y);
110:
111: public void setPadding(Dimension d);
112: }
|