Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.core.commands
Class AbstractHandlerWithState

java.lang.Object
  extended by 

org.eclipse.core.commands.common.EventManager
      extended by 

org.eclipse.core.commands.AbstractHandler
          extended by 
org.eclipse.core.commands.AbstractHandlerWithState
All Implemented Interfaces:
IHandler, IHandler2, IObjectWithState, IStateListener

public abstract class AbstractHandlerWithState
extends AbstractHandler
implements IObjectWithState, IStateListener

An abstract implementation of IObjectWithState. This provides basic handling for adding and remove state. When state is added, the handler attaches itself as a listener and fire a handleStateChange event to notify this handler. When state is removed, the handler removes itself as a listener.

Clients may extend this class.

Since:
3.2

Constructor Summary
AbstractHandlerWithState ()
           
 
Method Summary
 void addState ( String stateId, State state)
           Adds a state to this handler.
  State getState ( String stateId)
          Gets the state with the given id.
  String[] getStateIds ()
          Gets the identifiers for all of the state associated with this object.
 void removeState ( String stateId)
           Removes a state from this handler.
 
Methods inherited from class org.eclipse.core.commands. AbstractHandler
addHandlerListener, dispose, fireHandlerChanged, hasListeners, isEnabled, isHandled, removeHandlerListener, setBaseEnabled, setEnabled
 
Methods inherited from class org.eclipse.core.commands.common. EventManager
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject
 
Methods inherited from class java.lang. Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.eclipse.core.commands. IStateListener
handleStateChange
 
Methods inherited from interface org.eclipse.core.commands. IHandler
execute
 

Constructor Detail

AbstractHandlerWithState

public AbstractHandlerWithState()
Method Detail

addState

public void addState(
String stateId,
                     
State state)

Adds a state to this handler. This will add this handler as a listener to the state, and then fire a handleStateChange so that the handler can respond to the incoming state.

Clients may extend this method, but they should call this super method first before doing anything else.

Specified by:
addState in interface IObjectWithState
Parameters:
stateId - The identifier indicating the type of state being added; must not be null.
state - The state to add; must not be null.

getState

public final 
State getState(
String stateId)
Description copied from interface: IObjectWithState
Gets the state with the given id.

Specified by:
getState in interface IObjectWithState
Parameters:
stateId - The identifier of the state to retrieve; must not be null.
Returns:
The state; may be null if there is no state with the given id.

getStateIds

public final 
String[] getStateIds()
Description copied from interface: IObjectWithState
Gets the identifiers for all of the state associated with this object.

Specified by:
getStateIds in interface IObjectWithState
Returns:
All of the state identifiers; may be empty, but never null.

removeState

public void removeState(
String stateId)

Removes a state from this handler. This will remove this handler as a listener to the state. No event is fired to notify the handler of this change.

Clients may extend this method, but they should call this super method first before doing anything else.

Specified by:
removeState in interface IObjectWithState
Parameters:
stateId - The identifier of the state to remove; must not be null.

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire