jdk/src/share/classes/java/beans/AppletInitializer.java
author lana
Tue, 01 Jun 2010 14:17:38 -0700
changeset 5597 ab490f66d2cf
parent 5506 202f599c92aa
child 19213 c360667a0da2
permissions -rw-r--r--
Merge
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     2
 * Copyright (c) 1997, 2000, Oracle and/or its affiliates. All rights reserved.
2
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
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
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
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    23
 * questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package java.beans;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
import java.applet.Applet;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
import java.beans.beancontext.BeanContext;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 * This interface is designed to work in collusion with java.beans.Beans.instantiate.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 * The interafce is intended to provide mechanism to allow the proper
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 * initialization of JavaBeans that are also Applets, during their
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
 * instantiation by java.beans.Beans.instantiate().
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 * </p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
 * @see java.beans.Beans#instantiate
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
 * @since 1.2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
public interface AppletInitializer {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
     * If passed to the appropriate variant of java.beans.Beans.instantiate
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
     * this method will be called in order to associate the newly instantiated
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
     * Applet (JavaBean) with its AppletContext, AppletStub, and Container.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
     * </p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
     * Conformant implementations shall:
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
     * <ol>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
     * <li> Associate the newly instantiated Applet with the appropriate
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
     * AppletContext.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
     * <li> Instantiate an AppletStub() and associate that AppletStub with
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
     * the Applet via an invocation of setStub().
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
     * <li> If BeanContext parameter is null, then it shall associate the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
     * Applet with its appropriate Container by adding that Applet to its
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
     * Container via an invocation of add(). If the BeanContext parameter is
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
     * non-null, then it is the responsibility of the BeanContext to associate
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
     * the Applet with its Container during the subsequent invocation of its
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
     * addChildren() method.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
     * </ol>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
     * </p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
     * @param newAppletBean  The newly instantiated JavaBean
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
     * @param bCtxt          The BeanContext intended for this Applet, or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
     *                       null.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
    void initialize(Applet newAppletBean, BeanContext bCtxt);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
     * Activate, and/or mark Applet active. Implementors of this interface
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
     * shall mark this Applet as active, and optionally invoke its start()
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
     * method.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
     * </p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
     * @param newApplet  The newly instantiated JavaBean
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    89
90ce3da70b43 Initial load
duke
parents:
diff changeset
    90
    void activate(Applet newApplet);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    91
}