Home » openjdk-7 » java » awt » peer » [javadoc | source]

    1   /*
    2    * Copyright (c) 1996, 2007, Oracle and/or its affiliates. All rights reserved.
    3    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
    4    *
    5    * This code is free software; you can redistribute it and/or modify it
    6    * under the terms of the GNU General Public License version 2 only, as
    7    * published by the Free Software Foundation.  Oracle designates this
    8    * particular file as subject to the "Classpath" exception as provided
    9    * by Oracle in the LICENSE file that accompanied this code.
   10    *
   11    * This code is distributed in the hope that it will be useful, but WITHOUT
   12    * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
   13    * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
   14    * version 2 for more details (a copy is included in the LICENSE file that
   15    * accompanied this code).
   16    *
   17    * You should have received a copy of the GNU General Public License version
   18    * 2 along with this work; if not, write to the Free Software Foundation,
   19    * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   20    *
   21    * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
   22    * or visit www.oracle.com if you need additional information or have any
   23    * questions.
   24    */
   25   package java.awt.peer;
   26   
   27   import java.awt.Adjustable;
   28   import java.awt.ScrollPane;
   29   import java.awt.ScrollPaneAdjustable;
   30   
   31   /**
   32    * The peer interface for {@link ScrollPane}.
   33    *
   34    * The peer interfaces are intended only for use in porting
   35    * the AWT. They are not intended for use by application
   36    * developers, and developers should not implement peers
   37    * nor invoke any of the peer methods directly on the peer
   38    * instances.
   39    */
   40   public interface ScrollPanePeer extends ContainerPeer {
   41   
   42       /**
   43        * Returns the height of the horizontal scroll bar.
   44        *
   45        * @return the height of the horizontal scroll bar
   46        *
   47        * @see ScrollPane#getHScrollbarHeight()
   48        */
   49       int getHScrollbarHeight();
   50   
   51       /**
   52        * Returns the width of the vertical scroll bar.
   53        *
   54        * @return the width of the vertical scroll bar
   55        *
   56        * @see ScrollPane#getVScrollbarWidth()
   57        */
   58       int getVScrollbarWidth();
   59   
   60       /**
   61        * Sets the scroll position of the child.
   62        *
   63        * @param x the X coordinate of the scroll position
   64        * @param y the Y coordinate of the scroll position
   65        *
   66        * @see ScrollPane#setScrollPosition(int, int)
   67        */
   68       void setScrollPosition(int x, int y);
   69   
   70       /**
   71        * Called when the child component changes its size.
   72        *
   73        * @param w the new width of the child component
   74        * @param h the new height of the child component
   75        *
   76        * @see ScrollPane#layout()
   77        */
   78       void childResized(int w, int h);
   79   
   80       /**
   81        * Sets the unit increment of one of the scroll pane's adjustables.
   82        *
   83        * @param adj the scroll pane adjustable object
   84        * @param u the unit increment
   85        *
   86        * @see ScrollPaneAdjustable#setUnitIncrement(int)
   87        */
   88       void setUnitIncrement(Adjustable adj, int u);
   89   
   90       /**
   91        * Sets the value for one of the scroll pane's adjustables.
   92        *
   93        * @param adj the scroll pane adjustable object
   94        * @param v the value to set
   95        */
   96       void setValue(Adjustable adj, int v);
   97   }

Home » openjdk-7 » java » awt » peer » [javadoc | source]