Eclipse Plug-in Developer Guide (Galileo) - ChangeEncodingAction (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.ui.texteditor
Class ChangeEncodingAction


java.lang.Object
  

org.eclipse.core.commands.common.EventManager
      

org.eclipse.jface.action.AbstractAction
          

org.eclipse.jface.action.Action
              

org.eclipse.ui.texteditor.ResourceAction
                  

org.eclipse.ui.texteditor.TextEditorAction
                      
org.eclipse.ui.texteditor.ChangeEncodingAction

All Implemented Interfaces:: IAction, IUpdate

public class ChangeEncodingAction
extends TextEditorAction
extends TextEditorAction

Action for changing the encoding of the editor's input element.

The following keys, prepended by the given option prefix, are used for retrieving resources from the given bundle:

"dialog.title" - the input dialog's title

This class may be instantiated but is not intended to be subclassed.

Since:: 3.1
Restriction:: This class is not intended to be subclassed by clients.

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

Constructor Summary

ChangeEncodingAction ( ITextEditor editor)
          Creates a new action for the given text editor.

ChangeEncodingAction ( ResourceBundle bundle, String prefix, ITextEditor editor)
          Creates a new action for the given text editor.

Method Summary

void run ()
          The default implementation of this IAction method does nothing.

void update ()
          Always enables this action if it is connected to a text editor.

Methods inherited from class org.eclipse.ui.texteditor. TextEditorAction

canModifyEditor, getTextEditor, setEditor, validateEditorInputState

Methods inherited from class org.eclipse.ui.texteditor. ResourceAction

getString, initialize, setHelpContextId

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

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

addPropertyChangeListener, removePropertyChangeListener

Constructor Detail

ChangeEncodingAction

public ChangeEncodingAction(
ITextEditor editor)

Creates a new action for the given text editor.

Parameters:: editor - the text editor
Since:: 3.5
See Also:: TextEditorAction.TextEditorAction(ResourceBundle, String, ITextEditor)

ChangeEncodingAction

public ChangeEncodingAction(
ResourceBundle bundle,
                            
String prefix,
                            
ITextEditor editor)

Creates a new action for the given text editor. The action configures its visual representation from the given resource bundle.

Parameters:: bundle - the resource bundle; prefix - a prefix to be prepended to the various resource keys (described in ResourceAction constructor), or null if none; editor - the text editor
See Also:: TextEditorAction.TextEditorAction(ResourceBundle, String, ITextEditor)

Method Detail

run

public void run()

Description copied from class: Action

The default implementation of this IAction method does nothing. Subclasses should override this method if they do not need information from the triggering event, or override runWithEvent(Event) if they do.