Java Doc for FocusTraversalPolicy.java in  » 6.0-JDK-Core » AWT » java » awt » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Home
Java Source Code / Java Documentation
1.6.0 JDK Core
2.6.0 JDK Modules
3.6.0 JDK Modules com.sun
4.6.0 JDK Modules com.sun.java
5.6.0 JDK Modules sun
6.6.0 JDK Platform
7.Ajax
8.Apache Harmony Java SE
9.Aspect oriented
10.Authentication Authorization
11.Blogger System
12.Build
13.Byte Code
14.Cache
15.Chart
16.Chat
17.Code Analyzer
18.Collaboration
19.Content Management System
20.Database Client
21.Database DBMS
22.Database JDBC Connection Pool
23.Database ORM
24.Development
25.EJB Server
26.ERP CRM Financial
27.ESB
28.Forum
29.Game
30.GIS
31.Graphic 3D
32.Graphic Library
33.Groupware
34.HTML Parser
35.IDE
36.IDE Eclipse
37.IDE Netbeans
38.Installer
39.Internationalization Localization
40.Inversion of Control
41.Issue Tracking
42.J2EE
43.J2ME
44.JBoss
45.JMS
46.JMX
47.Library
48.Mail Clients
49.Music
50.Net
51.Parser
52.PDF
53.Portal
54.Profiler
55.Project Management
56.Report
57.RSS RDF
58.Rule Engine
59.Science
60.Scripting
61.Search Engine
62.Security
63.Sevlet Container
64.Source Control
65.Swing Library
66.Template Engine
67.Test Coverage
68.Testing
69.UML
70.Web Crawler
71.Web Framework
72.Web Mail
73.Web Server
74.Web Services
75.Web Services apache cxf 2.2.6
76.Web Services AXIS2
77.Wiki Engine
78.Workflow Engines
79.XML
80.XML UI
Java Source Code / Java Documentation » 6.0 JDK Core » AWT » java.awt 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   java.awt.FocusTraversalPolicy

All known Subclasses:   java.awt.ContainerOrderFocusTraversalPolicy,
FocusTraversalPolicy
abstract public class FocusTraversalPolicy (Code)
A FocusTraversalPolicy defines the order in which Components with a particular focus cycle root are traversed. Instances can apply the policy to arbitrary focus cycle roots, allowing themselves to be shared across Containers. They do not need to be reinitialized when the focus cycle roots of a Component hierarchy change.

The core responsibility of a FocusTraversalPolicy is to provide algorithms determining the next and previous Components to focus when traversing forward or backward in a UI. Each FocusTraversalPolicy must also provide algorithms for determining the first, last, and default Components in a traversal cycle. First and last Components are used when normal forward and backward traversal, respectively, wraps. The default Component is the first to receive focus when traversing down into a new focus traversal cycle. A FocusTraversalPolicy can optionally provide an algorithm for determining a Window's initial Component. The initial Component is the first to receive focus when a Window is first made visible.

FocusTraversalPolicy takes into account focus traversal policy providers. When searching for first/last/next/previous Component, if a focus traversal policy provider is encountered, its focus traversal policy is used to perform the search operation.

Please see How to Use the Focus Subsystem, a section in The Java Tutorial, and the Focus Specification for more information.
author:
   David Mendenhall
version:
   1.15, 05/05/07
See Also:   Container.setFocusTraversalPolicy
See Also:   Container.getFocusTraversalPolicy
See Also:   Container.setFocusCycleRoot
See Also:   Container.isFocusCycleRoot
See Also:   Container.setFocusTraversalPolicyProvider
See Also:   Container.isFocusTraversalPolicyProvider
See Also:   KeyboardFocusManager.setDefaultFocusTraversalPolicy
See Also:   KeyboardFocusManager.getDefaultFocusTraversalPolicy
since:
   1.4





Method Summary
abstract public  ComponentgetComponentAfter(Container aContainer, Component aComponent)
     Returns the Component that should receive the focus after aComponent.
abstract public  ComponentgetComponentBefore(Container aContainer, Component aComponent)
     Returns the Component that should receive the focus before aComponent.
abstract public  ComponentgetDefaultComponent(Container aContainer)
     Returns the default Component to focus.
abstract public  ComponentgetFirstComponent(Container aContainer)
     Returns the first Component in the traversal cycle.
public  ComponentgetInitialComponent(Window window)
     Returns the Component that should receive the focus when a Window is made visible for the first time.
abstract public  ComponentgetLastComponent(Container aContainer)
     Returns the last Component in the traversal cycle.



Method Detail
getComponentAfter
abstract public Component getComponentAfter(Container aContainer, Component aComponent)(Code)
Returns the Component that should receive the focus after aComponent. aContainer must be a focus cycle root of aComponent or a focus traversal policy provider.
Parameters:
  aContainer - a focus cycle root of aComponent or focus traversalpolicy provider
Parameters:
  aComponent - a (possibly indirect) child of aContainer, oraContainer itself the Component that should receive the focus after aComponent, ornull if no suitable Component can be found
throws:
  IllegalArgumentException - if aContainer is not a focus cycleroot of aComponent or a focus traversal policy provider, or if either aContainer or aComponent is null



getComponentBefore
abstract public Component getComponentBefore(Container aContainer, Component aComponent)(Code)
Returns the Component that should receive the focus before aComponent. aContainer must be a focus cycle root of aComponent or a focus traversal policy provider.
Parameters:
  aContainer - a focus cycle root of aComponent or focus traversalpolicy provider
Parameters:
  aComponent - a (possibly indirect) child of aContainer, oraContainer itself the Component that should receive the focus before aComponent,or null if no suitable Component can be found
throws:
  IllegalArgumentException - if aContainer is not a focus cycleroot of aComponent or a focus traversal policy provider, or if either aContainer or aComponent is null



getDefaultComponent
abstract public Component getDefaultComponent(Container aContainer)(Code)
Returns the default Component to focus. This Component will be the first to receive focus when traversing down into a new focus traversal cycle rooted at aContainer.
Parameters:
  aContainer - the focus cycle root or focus traversal policyprovider whose default Component is to be returned the default Component in the traversal cycle of aContainer, or null if no suitable Component can be found
throws:
  IllegalArgumentException - if aContainer is null



getFirstComponent
abstract public Component getFirstComponent(Container aContainer)(Code)
Returns the first Component in the traversal cycle. This method is used to determine the next Component to focus when traversal wraps in the forward direction.
Parameters:
  aContainer - the focus cycle root or focus traversal policy providerwhose first Component is to be returned the first Component in the traversal cycle of aContainer,or null if no suitable Component can be found
throws:
  IllegalArgumentException - if aContainer is null



getInitialComponent
public Component getInitialComponent(Window window)(Code)
Returns the Component that should receive the focus when a Window is made visible for the first time. Once the Window has been made visible by a call to show() or setVisible(true), the initial Component will not be used again. Instead, if the Window loses and subsequently regains focus, or is made invisible or undisplayable and subsequently made visible and displayable, the Window's most recently focused Component will become the focus owner. The default implementation of this method returns the default Component.
Parameters:
  window - the Window whose initial Component is to be returned the Component that should receive the focus when window is madevisible for the first time, or null if no suitable Component canbe found
See Also:   FocusTraversalPolicy.getDefaultComponent
See Also:   Window.getMostRecentFocusOwner
throws:
  IllegalArgumentException - if window is null



getLastComponent
abstract public Component getLastComponent(Container aContainer)(Code)
Returns the last Component in the traversal cycle. This method is used to determine the next Component to focus when traversal wraps in the reverse direction.
Parameters:
  aContainer - the focus cycle root or focus traversal policyprovider whose last Component is to be returned the last Component in the traversal cycle of aContainer,or null if no suitable Component can be found
throws:
  IllegalArgumentException - if aContainer is null



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.