In this reference implementation, this class can also be used to register controllers with the default environment as "plug-ins". A plug-in is created by subclassing ControllerEnvironment with a class that has a public no-argument constructor, implements the net.java.games.util.plugins.Plugin interface and has a name ending in "Plugin". (See net.java.games.input.DirectInputEnvironmentPlugin in the DXplugin part of the source tree for an example.) When the DefaultControllerEnvrionment is instanced it uses the plugin library to look for Plugins in both [java.home]/lib/controller and [user.dir]/controller. This allows controller plugins to be installed either globally for the entire Java environment or locally for just one particular Java app. For more information on the organization of plugins within the controller root directories, see net.java.games.util.plugins.Plugins (Note the plural -- "Plugins" not "Plugin" which is just a marker interface.)
| Modifier and Type | Field and Description |
|---|---|
| protected final ArrayList | controllerListeners
List of controller listeners |
| private static ControllerEnvironment | defaultEnvironment
The default controller environment |
| Access | Constructor and Description |
|---|---|
| protected |
| Modifier and Type | Method and Description |
|---|---|
| public void | |
| protected void | fireControllerAdded(Controller c)
Creates and sends an event to the controller listeners that a controller has been added. |
| protected void | fireControllerRemoved(Controller c)
Creates and sends an event to the controller listeners that a controller has been lost. |
| public abstract Controller[] | getControllers()
Returns a list of all controllers available to this environment, or an empty array if there are no controllers in this environment. |
| public static ControllerEnvironment | |
| public abstract boolean | |
| pack-priv static void | |
| public void | removeControllerListener(ControllerListener l)
Removes a listener for controller state change events. |
| controllerListeners | back to summary |
|---|---|
| protected final ArrayList<ControllerListener> controllerListeners List of controller listeners | |
| defaultEnvironment | back to summary |
|---|---|
| private static ControllerEnvironment defaultEnvironment The default controller environment | |
| ControllerEnvironment | back to summary |
|---|---|
| protected ControllerEnvironment() Protected constructor for subclassing. | |
| addControllerListener | back to summary |
|---|---|
| public void addControllerListener(ControllerListener l) Adds a listener for controller state change events. | |
| fireControllerAdded | back to summary |
|---|---|
| protected void fireControllerAdded(Controller c) Creates and sends an event to the controller listeners that a controller has been added. | |
| fireControllerRemoved | back to summary |
|---|---|
| protected void fireControllerRemoved(Controller c) Creates and sends an event to the controller listeners that a controller has been lost. | |
| getControllers | back to summary |
|---|---|
| public abstract Controller[] getControllers() Returns a list of all controllers available to this environment, or an empty array if there are no controllers in this environment. | |
| getDefaultEnvironment | back to summary |
|---|---|
| public static ControllerEnvironment getDefaultEnvironment() Returns the default environment for input controllers. This usually corresponds to the environment for the local machine. | |
| isSupported | back to summary |
|---|---|
| public abstract boolean isSupported() Returns the isSupported status of this environment. What makes an environment supported or not is up to the particular plugin, but may include OS or available hardware. | |
| log | back to summary |
|---|---|
| pack-priv static void log(String msg) | |
| removeControllerListener | back to summary |
|---|---|
| public void removeControllerListener(ControllerListener l) Removes a listener for controller state change events. | |