org.eclipse.mtj.ui.editors.jad
Class AbstractJADEditorPage
java.lang.Object
FormPage
org.eclipse.mtj.ui.editors.jad.AbstractJADEditorPage
-
Direct Known Subclasses:
-
JADPropertiesEditorPage
-
public abstract class AbstractJADEditorPage
- extends FormPage
Abstract superclass of the multi-page editor pages.
-
Since:
- 1.0
|
Method Summary
|
protected void
|
configureFormText
(Form form,
FormText text)
|
protected FormText
|
createClient
(Composite section,
String content,
FormToolkit toolkit,
IHyperlinkListener listener)
|
protected void
|
createErrorMessageHandler
(IManagedForm managedForm)
|
protected void
|
createFormContent
(IManagedForm managedForm)
|
protected Section
|
createStaticBasicSection
(FormToolkit toolkit,
Composite parent,
String text,
String description)
|
protected Section
|
createStaticSection
(FormToolkit toolkit,
Composite parent,
String text)
|
protected Composite
|
createStaticSectionClient
(FormToolkit toolkit,
Composite parent)
|
void
|
dispose
()
|
void
|
doSaveAs
()
|
void
|
editorDirtyStateChanged
()
Let the editor know that the dirty state has changed. |
abstract void
|
editorInputChanged
()
An indication to this page that the editor input has been updated
external to Eclipse and the page should be updated. |
IMessageManager
|
getErrorMessageManager
()
|
protected abstract
String
|
getHelpResource
()
|
IJavaProject
|
getJavaProject
()
Return the java project holding the JAD file. |
protected
IManifestPreferenceStore
|
getPreferenceStore
()
Get the preference store being edited. |
abstract
String
|
getTitle
()
|
void
|
initialize
(FormEditor editor)
|
boolean
|
isDirty
()
|
abstract boolean
|
isManagingProperty
(
String property)
Return a boolean indicating whether the specified property is managed by
this page. |
boolean
|
isSaveAsAllowed
()
|
void
|
linkActivated
(HyperlinkEvent e)
Subclasses can extend this method and add custom link activation
handling. |
void
|
linkEntered
(HyperlinkEvent e)
|
void
|
linkExited
(HyperlinkEvent e)
|
void
|
setDirty
(boolean dirty)
Set the dirty flag and let the editor know the state has changed. |
void
|
setInitializationData
(IConfigurationElement cfig,
String propertyName,
Object data)
|
|
Methods inherited from class java.lang.
Object
|
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait
|
AbstractJADEditorPage
public AbstractJADEditorPage(org.eclipse.mtj.internal.ui.editors.jad.form.JADFormEditor editor,
String id,
String title)
- A constructor that creates the JAD EditorPage and initializes it with the
editor.
-
Parameters:
-
editor - the parent editor -
id - the unique identifier -
title - the page title -
Restriction:
- This constructor is not intended to be referenced by clients.
AbstractJADEditorPage
public AbstractJADEditorPage(
String id)
- A constructor that creates the JAD EditorPage. The parent editor need to
be passed in the
initialize method if this constructor is
used. The page title will be the same as the id.
-
Parameters:
-
id - a unique page identifier
AbstractJADEditorPage
public AbstractJADEditorPage(
String id,
String title)
- A constructor that creates the JAD EditorPage. The parent editor need to
be passed in the
initialize method if this constructor is
used.
-
Parameters:
-
id - a unique page identifier -
title - a user-friendly page title
dispose
public void dispose()
-
doSaveAs
public void doSaveAs()
-
editorDirtyStateChanged
public void editorDirtyStateChanged()
- Let the editor know that the dirty state has changed.
-
editorInputChanged
public abstract void editorInputChanged()
- An indication to this page that the editor input has been updated
external to Eclipse and the page should be updated.
-
getErrorMessageManager
public IMessageManager getErrorMessageManager()
-
getJavaProject
public IJavaProject getJavaProject()
- Return the java project holding the JAD file.
-
-
Returns:
- A reference to the IJavaProject that contains this jad file
getTitle
public abstract
String getTitle()
-
initialize
public void initialize(FormEditor editor)
-
isDirty
public boolean isDirty()
-
isManagingProperty
public abstract boolean isManagingProperty(
String property)
- Return a boolean indicating whether the specified property is managed by
this page.
-
-
Parameters:
-
property -
-
Returns:
-
isSaveAsAllowed
public boolean isSaveAsAllowed()
-
linkActivated
public void linkActivated(HyperlinkEvent e)
- Subclasses can extend this method and add custom link activation
handling. By default this method is just an stub.
-
-
Parameters:
-
e - an event containing information about the hyperlink -
See Also:
-
org.eclipse.ui.forms.events.IHyperlinkListener#linkActivated(org.eclipse.ui.forms.events.HyperlinkEvent)
linkEntered
public void linkEntered(HyperlinkEvent e)
-
linkExited
public void linkExited(HyperlinkEvent e)
-
setDirty
public void setDirty(boolean dirty)
- Set the dirty flag and let the editor know the state has changed.
-
-
Parameters:
-
dirty - whether the page contents are currently dirty
setInitializationData
public void setInitializationData(IConfigurationElement cfig,
String propertyName,
Object data)
-
configureFormText
protected void configureFormText(Form form,
FormText text)
-
-
Parameters:
-
form - -
text -
createClient
protected final FormText createClient(Composite section,
String content,
FormToolkit toolkit,
IHyperlinkListener listener)
-
-
Parameters:
-
section - -
content - -
toolkit -
-
Returns:
-
createErrorMessageHandler
protected void createErrorMessageHandler(IManagedForm managedForm)
-
-
Parameters:
-
managedForm -
createFormContent
protected void createFormContent(IManagedForm managedForm)
-
createStaticBasicSection
protected final Section createStaticBasicSection(FormToolkit toolkit,
Composite parent,
String text,
String description)
-
-
Parameters:
-
toolkit - -
parent - -
text - -
description -
-
Returns:
-
createStaticSection
protected final Section createStaticSection(FormToolkit toolkit,
Composite parent,
String text)
-
-
Parameters:
-
toolkit - -
parent - -
text -
-
Returns:
-
createStaticSectionClient
protected Composite createStaticSectionClient(FormToolkit toolkit,
Composite parent)
-
-
Parameters:
-
toolkit - -
parent -
-
Returns:
-
getHelpResource
protected abstract
String getHelpResource()
-
-
Returns:
- the URL of the help resource.
getPreferenceStore
protected
IManifestPreferenceStore getPreferenceStore()
- Get the preference store being edited.
-
