Eclipse Platform
Release 3.3

org.eclipse.ui.texteditor.rulers
Class RulerColumnPreferenceAdapter

java.lang.Object
  extended byorg.eclipse.ui.texteditor.rulers.RulerColumnPreferenceAdapter

public final class RulerColumnPreferenceAdapter
extends Object

Manages the preferences for ruler contributions stored in a preference store.

Since:
3.3

Constructor Summary
RulerColumnPreferenceAdapter(IPreferenceStore store, String key)
          Creates a new preference adapter that will read and write under the specified key in the given preference store.
 
Method Summary
 boolean isEnabled(RulerColumnDescriptor descriptor)
          Returns the enablement state of the given ruler contribution.
 void setEnabled(RulerColumnDescriptor descriptor, boolean enabled)
          Sets the enablement state of the given ruler contribution.
 void toggle(RulerColumnDescriptor descriptor)
          Toggles the enablement state of given the ruler contribution.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RulerColumnPreferenceAdapter

public RulerColumnPreferenceAdapter(IPreferenceStore store,
                                    String key)
Creates a new preference adapter that will read and write under the specified key in the given preference store.

Parameters:
store - the preference store
key - the key
Method Detail

isEnabled

public boolean isEnabled(RulerColumnDescriptor descriptor)
Returns the enablement state of the given ruler contribution.

Parameters:
descriptor - a ruler contribution descriptor
Returns:
true if the ruler is enabled, false otherwise

setEnabled

public void setEnabled(RulerColumnDescriptor descriptor,
                       boolean enabled)
Sets the enablement state of the given ruler contribution.

Parameters:
descriptor - a ruler contribution descriptor
enabled - true to enable the contribution, false to disable it

toggle

public void toggle(RulerColumnDescriptor descriptor)
Toggles the enablement state of given the ruler contribution.

Parameters:
descriptor - a ruler contribution descriptor

Eclipse Platform
Release 3.3

Guidelines for using Eclipse APIs.

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