Java Doc for TextEditorAction.java in » IDE-Eclipse » ui-workbench » org » eclipse » ui » texteditor » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » IDE Eclipse » ui workbench » org.eclipse.ui.texteditor

Source Cross Reference Class Diagram Java Document (Java Doc)

org.eclipse.ui.texteditor .ResourceAction

org.eclipse.ui.texteditor .TextEditorAction

All known Subclasses:   org.eclipse.ui.texteditor .InsertLineAction,  org.eclipse.ui.internal.texteditor.quickdiff .QuickDiffRestoreAction,  org.eclipse.ui.texteditor .RecenterAction,  org.eclipse.ui.texteditor .SelectAnnotationRulerAction,  org.eclipse.ui.texteditor .JoinLinesAction,  org.eclipse.ui.texteditor .DeleteLineAction,  org.eclipse.ui.texteditor .ShowWhitespaceCharactersAction,  org.eclipse.ui.texteditor .TextOperationAction,  org.eclipse.ui.texteditor .RevertToSavedAction,  org.eclipse.ui.texteditor .SaveAction,  org.eclipse.ui.texteditor .MoveLinesAction,  org.eclipse.ui.texteditor .MarkAction,  org.eclipse.ui.texteditor .ConvertLineDelimitersAction,  org.eclipse.ui.texteditor .HippieCompleteAction,  org.eclipse.ui.texteditor .ContentAssistAction,  org.eclipse.ui.texteditor .CaseAction,  org.eclipse.ui.texteditor .ShiftAction,  org.eclipse.ui.texteditor .GotoAnnotationAction,  org.eclipse.ui.texteditor .GotoLineAction,
TextEditorAction
abstract public class TextEditorAction extends ResourceAction implements IUpdate(Code)
Skeleton of a standard text editor action. The action is initially associated with a text editor via the constructor, but can subsequently be changed using setEditor. Subclasses must implement the run method and if required override the update method.
Subclasses that may modify the editor content should use TextEditorAction.canModifyEditor() in their update code to check whether updating the editor is most likely possible (even if it is read-only - this may change for editor contents that are under version control) and TextEditorAction.validateEditorInputState() before actually modifying the editor contents.

Constructor Summary
protected TextEditorAction(ResourceBundle bundle, String prefix, ITextEditor editor)
     Creates and initializes the action for the given text editor.
protected TextEditorAction(ResourceBundle bundle, String prefix, ITextEditor editor, int style)
     Creates and initializes the action for the given text editor.

Method Summary
protected boolean canModifyEditor()
     Checks the editor's modifiable state.
protected ITextEditor getTextEditor()
     Returns the action's text editor.
public void setEditor(ITextEditor editor)
     Retargets this action to the given editor.
public void update()
     Always enables this action if it is connected to a text editor.
protected boolean validateEditorInputState()
     Checks and validates the editor's modifiable state.

Constructor Detail
TextEditorAction
protected TextEditorAction(ResourceBundle bundle, String prefix, ITextEditor editor)(Code)
Creates and initializes the action for the given text editor. The action configures its visual representation from the given resource bundle.
Parameters:
  bundle - the resource bundle
Parameters:
  prefix - a prefix to be prepended to the various resource keys(described in ResourceAction constructor), ornull if none
Parameters:
  editor - the text editor
See Also:   ResourceAction.ResourceAction(ResourceBundleString)

TextEditorAction
protected TextEditorAction(ResourceBundle bundle, String prefix, ITextEditor editor, int style)(Code)
Creates and initializes the action for the given text editor. The action configures its visual representation from the given resource bundle.
Parameters:
  bundle - the resource bundle
Parameters:
  prefix - a prefix to be prepended to the various resource keys(described in ResourceAction constructor), ornull if none
Parameters:
  editor - the text editor
Parameters:
  style - the style of this action
See Also:   ResourceAction.ResourceAction(ResourceBundleStringint)
since:
   3.0

Method Detail
canModifyEditor
protected boolean canModifyEditor()(Code)
Checks the editor's modifiable state. Returns true if the editor can be modified, taking in account the possible editor extensions.
If the editor implements ITextEditorExtension2, this method returns ITextEditorExtension2.isEditorInputModifiable ;
else if the editor implements ITextEditorExtension, it returns ITextEditorExtension.isEditorInputReadOnly ;
else, ITextEditor.isEditable is returned, or false if the editor is null.

There is only a difference to TextEditorAction.validateEditorInputState() if the editor implements ITextEditorExtension2.
true if a modifying action should be enabled, false otherwise
since:
   3.0

getTextEditor
protected ITextEditor getTextEditor()(Code)
Returns the action's text editor. the action's text editor

setEditor
public void setEditor(ITextEditor editor)(Code)
Retargets this action to the given editor.
Parameters:
  editor - the new editor, or null if none

update
public void update()(Code)
Always enables this action if it is connected to a text editor. If the associated editor is null, the action is disabled. Subclasses may override.

validateEditorInputState
protected boolean validateEditorInputState()(Code)
Checks and validates the editor's modifiable state. Returns true if an action can proceed modifying the editor's input, false if it should not.
If the editor implements ITextEditorExtension2, this method returns ITextEditorExtension2.validateEditorInputState ;
else if the editor implements ITextEditorExtension, it returns ITextEditorExtension.isEditorInputReadOnly ;
else, ITextEditor.isEditable is returned, or false if the editor is null.

There is only a difference to TextEditorAction.canModifyEditor() if the editor implements ITextEditorExtension2.
true if a modifying action can proceed to modify the underlying document, false otherwise
since:
   3.0

Methods inherited from org.eclipse.ui.texteditor.ResourceAction
protected static String getString(ResourceBundle bundle, String key, String defaultValue)(Code)(Java Doc)
protected void initialize(ResourceBundle bundle, String prefix)(Code)(Java Doc)
final public void setHelpContextId(String contextId)(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.