Package com.developer.nefarious.zjoule.plugin.core.functions

Class PreferencesHandler

java.lang.Object
org.eclipse.core.commands.common.EventManager
org.eclipse.jface.action.AbstractAction
org.eclipse.jface.action.Action
com.developer.nefarious.zjoule.plugin.core.functions.PreferencesHandler
All Implemented Interfaces:
org.eclipse.jface.action.IAction
public class PreferencesHandler extends org.eclipse.jface.action.Action
Handles opening the preferences dialog in the Eclipse plugin.

The PreferencesHandler extends Action to provide a UI action that allows users to access the plugin's settings via the Eclipse preferences page. It sets an icon for the action and executes the preferences dialog when triggered.

  • Field Summary

    Fields inherited from interface org.eclipse.jface.action.IAction

    AS_CHECK_BOX, AS_DROP_DOWN_MENU, AS_PUSH_BUTTON, AS_RADIO_BUTTON, AS_UNSPECIFIED, CHECKED, DESCRIPTION, ENABLED, HANDLED, IMAGE, RESULT, TEXT, TOOL_TIP_TEXT

  • Method Summary

    Modifier and Type
    Method
    Description
    static PreferencesHandler
    create()
    Creates and returns an instance of PreferencesHandler.
    void
    run()
    Opens the preferences dialog for the plugin when the action is triggered.

    Methods inherited from class org.eclipse.jface.action.Action

    convertAccelerator, convertAccelerator, findKeyCode, findKeyString, findModifier, findModifierString, getAccelerator, getActionDefinitionId, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getMenuCreator, getStyle, getText, getToolTipText, isChecked, isEnabled, isHandled, notifyResult, removeAcceleratorText, removeMnemonics, runWithEvent, setAccelerator, setActionDefinitionId, setChecked, setDescription, setDisabledImageDescriptor, setEnabled, setHelpListener, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipText

    Methods inherited from class org.eclipse.jface.action.AbstractAction

    addPropertyChangeListener, firePropertyChange, firePropertyChange, removePropertyChangeListener

    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

  • Method Details

    • create

      public static PreferencesHandler create()
      Creates and returns an instance of PreferencesHandler.
      Returns:
      a new instance of PreferencesHandler.

    • run

      public void run()
      Opens the preferences dialog for the plugin when the action is triggered.

      This method invokes the Eclipse Preferences API to display the preference dialog corresponding to PREFERENCES_PAGE_ID.

      Specified by:
      run in interface org.eclipse.jface.action.IAction
      Overrides:
      run in class org.eclipse.jface.action.Action