Eclipse Platform
Release 3.3

org.eclipse.ui.navigator
Interface IExtensionStateModel


public interface IExtensionStateModel

Allows clients to coordinate state across components that are part of the same logical extension.

That is, a content provider might vary how it exposes its content based on the state of a specific property in the model. Interested parties may add themselves as IPropertyChangeListeners to track changes in the state model.

This interface is not intended to be implemented by clients.

Since:
3.2

Method Summary
 void addPropertyChangeListener(IPropertyChangeListener aListener)
           
 boolean getBooleanProperty(String aPropertyName)
           
 String getId()
          The id is used to look up the state model across different components of the same logical extension.
 int getIntProperty(String aPropertyName)
           
 Object getProperty(String aPropertyName)
           
 String getStringProperty(String aPropertyName)
           
 String getViewerId()
           
 void removePropertyChangeListener(IPropertyChangeListener aListener)
           
 void setBooleanProperty(String aPropertyName, boolean aPropertyValue)
           
 void setIntProperty(String aPropertyName, int aPropertyValue)
           
 void setProperty(String aPropertyName, Object aPropertyValue)
           
 void setStringProperty(String aPropertyName, String aPropertyValue)
           
 

Method Detail

getId

public String getId()
The id is used to look up the state model across different components of the same logical extension. Generally, the id of the content extension is used.

Returns:
The unique identifier of this state model.

getViewerId

public String getViewerId()
Returns:
The viewer id that this state model is associated with.

getStringProperty

public String getStringProperty(String aPropertyName)
Parameters:
aPropertyName - The name of a given property
Returns:
The current value of the property.

getBooleanProperty

public boolean getBooleanProperty(String aPropertyName)
Parameters:
aPropertyName - The name of a given property
Returns:
The current value of the property.

getIntProperty

public int getIntProperty(String aPropertyName)
Parameters:
aPropertyName - The name of a given property
Returns:
The current value of the property.

getProperty

public Object getProperty(String aPropertyName)
Parameters:
aPropertyName - The name of a given property
Returns:
The current value of the property.

setStringProperty

public void setStringProperty(String aPropertyName,
                              String aPropertyValue)
Parameters:
aPropertyName - The name of a given property
aPropertyValue - The new value of a the given property.

setBooleanProperty

public void setBooleanProperty(String aPropertyName,
                               boolean aPropertyValue)
Parameters:
aPropertyName - The name of a given property
aPropertyValue - The new value of a the given property.

setIntProperty

public void setIntProperty(String aPropertyName,
                           int aPropertyValue)
Parameters:
aPropertyName - The name of a given property
aPropertyValue - The new value of a the given property.

setProperty

public void setProperty(String aPropertyName,
                        Object aPropertyValue)
Parameters:
aPropertyName - The name of a given property
aPropertyValue - The new value of a the given property.

addPropertyChangeListener

public void addPropertyChangeListener(IPropertyChangeListener aListener)
Parameters:
aListener - An implementation of IPropertyChangeListener that should be notified when changes occur in this model.

removePropertyChangeListener

public void removePropertyChangeListener(IPropertyChangeListener aListener)
Parameters:
aListener - An implementation of IPropertyChangeListener that should no longer be notified when changes occur in this model.

Eclipse Platform
Release 3.3

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2007. All rights reserved.