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.

Since:

3.2

Restriction:

This interface is not intended to be implemented by clients.

Restriction:

This interface is not intended to be extended by clients.

Method Summary

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

Method Detail

getId

java.lang.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

java.lang.String getViewerId()

Returns:

The viewer id that this state model is associated with.

getStringProperty

java.lang.String getStringProperty(java.lang.String aPropertyName)

Parameters:

aPropertyName - The name of a given property

Returns:

The current value of the property.

getBooleanProperty

boolean getBooleanProperty(java.lang.String aPropertyName)

Parameters:

aPropertyName - The name of a given property

Returns:

The current value of the property.

getIntProperty

int getIntProperty(java.lang.String aPropertyName)

Parameters:

aPropertyName - The name of a given property

Returns:

The current value of the property.

getProperty

java.lang.Object getProperty(java.lang.String aPropertyName)

Parameters:

aPropertyName - The name of a given property

Returns:

The current value of the property.

setStringProperty

void setStringProperty(java.lang.String aPropertyName,
                       java.lang.String aPropertyValue)

Parameters:

aPropertyName - The name of a given property

aPropertyValue - The new value of a the given property.

setBooleanProperty

void setBooleanProperty(java.lang.String aPropertyName,
                        boolean aPropertyValue)

Parameters:

aPropertyName - The name of a given property

aPropertyValue - The new value of a the given property.

setIntProperty

void setIntProperty(java.lang.String aPropertyName,
                    int aPropertyValue)

Parameters:

aPropertyName - The name of a given property

aPropertyValue - The new value of a the given property.

setProperty

void setProperty(java.lang.String aPropertyName,
                 java.lang.Object aPropertyValue)

Parameters:

aPropertyName - The name of a given property

aPropertyValue - The new value of a the given property.

addPropertyChangeListener

void addPropertyChangeListener(IPropertyChangeListener aListener)

Parameters:

aListener - An implementation of IPropertyChangeListener that should be notified when changes occur in this model.

removePropertyChangeListener

void removePropertyChangeListener(IPropertyChangeListener aListener)

Parameters:

aListener - An implementation of IPropertyChangeListener that should no longer be notified when changes occur in this model.