jdk/src/share/classes/java/awt/peer/TextFieldPeer.java
author rkennke
Tue, 13 Jan 2009 20:04:05 +0100
changeset 1975 b8dae32335f2
parent 1964 934568dfe859
child 5506 202f599c92aa
permissions -rw-r--r--
6792515: Specify awt peer's API Summary: Document AWT peer API. Reviewed-by: art, dav
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
90ce3da70b43 Initial load
duke
parents:
diff changeset
     2
 * Copyright 1995-1998 Sun Microsystems, Inc.  All Rights Reserved.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
90ce3da70b43 Initial load
duke
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Sun designates this
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
90ce3da70b43 Initial load
duke
parents:
diff changeset
     9
 * by Sun in the LICENSE file that accompanied this code.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    21
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    22
 * CA 95054 USA or visit www.sun.com if you need additional information or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    23
 * have any questions.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
package java.awt.peer;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
import java.awt.Dimension;
1975
b8dae32335f2 6792515: Specify awt peer's API
rkennke
parents: 1964
diff changeset
    28
import java.awt.TextField;
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
/**
1975
b8dae32335f2 6792515: Specify awt peer's API
rkennke
parents: 1964
diff changeset
    31
 * The peer interface for {@link TextField}.
b8dae32335f2 6792515: Specify awt peer's API
rkennke
parents: 1964
diff changeset
    32
 *
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 * The peer interfaces are intended only for use in porting
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 * the AWT. They are not intended for use by application
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 * developers, and developers should not implement peers
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 * nor invoke any of the peer methods directly on the peer
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
 * instances.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
public interface TextFieldPeer extends TextComponentPeer {
1975
b8dae32335f2 6792515: Specify awt peer's API
rkennke
parents: 1964
diff changeset
    40
b8dae32335f2 6792515: Specify awt peer's API
rkennke
parents: 1964
diff changeset
    41
    /**
b8dae32335f2 6792515: Specify awt peer's API
rkennke
parents: 1964
diff changeset
    42
     * Sets the echo character.
b8dae32335f2 6792515: Specify awt peer's API
rkennke
parents: 1964
diff changeset
    43
     *
b8dae32335f2 6792515: Specify awt peer's API
rkennke
parents: 1964
diff changeset
    44
     * @param echoChar the echo character to set
b8dae32335f2 6792515: Specify awt peer's API
rkennke
parents: 1964
diff changeset
    45
     *
b8dae32335f2 6792515: Specify awt peer's API
rkennke
parents: 1964
diff changeset
    46
     * @see TextField#getEchoChar()
b8dae32335f2 6792515: Specify awt peer's API
rkennke
parents: 1964
diff changeset
    47
     */
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
    void setEchoChar(char echoChar);
1975
b8dae32335f2 6792515: Specify awt peer's API
rkennke
parents: 1964
diff changeset
    49
b8dae32335f2 6792515: Specify awt peer's API
rkennke
parents: 1964
diff changeset
    50
    /**
b8dae32335f2 6792515: Specify awt peer's API
rkennke
parents: 1964
diff changeset
    51
     * Returns the preferred size of the text field with the specified number
b8dae32335f2 6792515: Specify awt peer's API
rkennke
parents: 1964
diff changeset
    52
     * of columns.
b8dae32335f2 6792515: Specify awt peer's API
rkennke
parents: 1964
diff changeset
    53
     *
b8dae32335f2 6792515: Specify awt peer's API
rkennke
parents: 1964
diff changeset
    54
     * @param columns the number of columns
b8dae32335f2 6792515: Specify awt peer's API
rkennke
parents: 1964
diff changeset
    55
     *
b8dae32335f2 6792515: Specify awt peer's API
rkennke
parents: 1964
diff changeset
    56
     * @return the preferred size of the text field
b8dae32335f2 6792515: Specify awt peer's API
rkennke
parents: 1964
diff changeset
    57
     *
b8dae32335f2 6792515: Specify awt peer's API
rkennke
parents: 1964
diff changeset
    58
     * @see TextField#getPreferredSize(int)
b8dae32335f2 6792515: Specify awt peer's API
rkennke
parents: 1964
diff changeset
    59
     */
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
    Dimension getPreferredSize(int columns);
1975
b8dae32335f2 6792515: Specify awt peer's API
rkennke
parents: 1964
diff changeset
    61
b8dae32335f2 6792515: Specify awt peer's API
rkennke
parents: 1964
diff changeset
    62
    /**
b8dae32335f2 6792515: Specify awt peer's API
rkennke
parents: 1964
diff changeset
    63
     * Returns the minimum size of the text field with the specified number
b8dae32335f2 6792515: Specify awt peer's API
rkennke
parents: 1964
diff changeset
    64
     * of columns.
b8dae32335f2 6792515: Specify awt peer's API
rkennke
parents: 1964
diff changeset
    65
     *
b8dae32335f2 6792515: Specify awt peer's API
rkennke
parents: 1964
diff changeset
    66
     * @param columns the number of columns
b8dae32335f2 6792515: Specify awt peer's API
rkennke
parents: 1964
diff changeset
    67
     *
b8dae32335f2 6792515: Specify awt peer's API
rkennke
parents: 1964
diff changeset
    68
     * @return the minimum size of the text field
b8dae32335f2 6792515: Specify awt peer's API
rkennke
parents: 1964
diff changeset
    69
     *
b8dae32335f2 6792515: Specify awt peer's API
rkennke
parents: 1964
diff changeset
    70
     * @see TextField#getMinimumSize(int)
b8dae32335f2 6792515: Specify awt peer's API
rkennke
parents: 1964
diff changeset
    71
     */
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
    Dimension getMinimumSize(int columns);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
}