PanelFocusCookie


1   /*
2    * The contents of this file are subject to the terms of the Common Development
3    * and Distribution License (the License). You may not use this file except in
4    * compliance with the License.
5    *
6    * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7    * or http://www.netbeans.org/cddl.txt.
8    *
9    * When distributing Covered Code, include this CDDL Header Notice in each file
10   * and include the License file at http://www.netbeans.org/cddl.txt.
11   * If applicable, add the following below the CDDL Header, with the fields
12   * enclosed by brackets [] replaced by your own identifying information:
13   * "Portions Copyrighted [year] [name of copyright owner]"
14   *
15   * The Original Software is NetBeans. The Initial Developer of the Original
16   * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17   * Microsystems, Inc. All Rights Reserved.
18   */
19  package org.netbeans.modules.j2ee.sun.share.config.ui;
20  
21  import org.openide.loaders.*;
22  
23  /**
24   * This interface provides a generic way to set Focus on a object represented in a ComponentPanel editor. It is
25   * expected that the Open Support/OpenCookie/TopComponent for an specific ComponentPanel editor would implement this cookie and then delegate
26   * to the ComponentPanel. Most ComponentPanels would then delegate to their child PanelView's. The PanelView's could then
27   * delegate to individual panels that implement this interface or use some other mechanism to find the focusObject. The set focusObject's
28   * supported by a particular PanelView or Panel is defined by that respective PanelView or Panel and should be documented by them.
29   * The panelViewNameHint and panelNameHint can be used as hints to restrict the search or for disambiguation or to at least
30   * put the focus on the appropriate panel even if the Object could not be resolved.
31   * @author  bashby
32   * @version 1.0
33   */
34  
35  public interface PanelFocusCookie  {
36      /**
37       * Request that the focus be set on the identified object using the name of the PanelView and/or panel as hints
38       * to find the object.
39       * @param String panelViewNameHint String used as a hint for the appropriate PanelView if there is more than one.
40       * @param String panelNameHint String used as a hint for the appropiate panel in the PanelView
41       * @param Object focusObject Object that can be used to identify the object that should have the focus.
42       * @return boolean return true if the focus was able to be set on the identified Object
43       */
44      public boolean setFocusOn(String   panelViewNameHint, String   panelNameHint, Object   focusObject);
45  }
46
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags