Source code

001/*
002 * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation.  Oracle designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Oracle in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
022 * or visit www.oracle.com if you need additional information or have any
023 * questions.
024 */
025
026package javafx.fxml;
027
028import java.net.URL;
029import java.util.ResourceBundle;
030
031/**
032 * Controller initialization interface.
033 * <p>
034 * <em>NOTE</em> This interface has been superseded by automatic injection of
035 * <code>location</code> and <code>resources</code> properties into the
036 * controller. {@link FXMLLoader} will now automatically call any suitably
037 * annotated no-arg <code>initialize()</code> method defined by the controller.
038 * It is recommended that the injection approach be used whenever possible.
039 */
040public interface Initializable {
041    /**
042     * Called to initialize a controller after its root element has been
043     * completely processed.
044     *
045     * @param location
046     * The location used to resolve relative paths for the root object, or
047     * <tt>null</tt> if the location is not known.
048     *
049     * @param resources
050     * The resources used to localize the root object, or <tt>null</tt> if
051     * the root object was not localized.
052     */
053    public void initialize(URL location, ResourceBundle resources);
054}