IEditable

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> eclipse >> pde >> [ core overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.eclipse.pde.core.IEditable

SOURCE |

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.pde.core
Interface IEditable

All Known Subinterfaces:: IEditableModel

public interface IEditable

Models that implement this interface indicate that they can be changed. When a model is changed, it becomes 'dirty'. This state can either be reset (in case of a 'false alarm' or naturally set to false as a result of saving the changes. Models that implement this interface are expected to be able to save in ASCII file format (e.g. XML).

Since:: 2.0

Method Summary

boolean isDirty()
          Tests whether the model has been changed from the last clean state.

boolean isEditable()
          Tests whether the model marked as editable can be edited.

void save(java.io.PrintWriter writer)
          Saves the model into the provided writer.

void setDirty(boolean dirty)
          Sets the dirty flag of the model.

Method Detail

isEditable

public boolean isEditable()

Tests whether the model marked as editable can be edited. Even though a model is generally editable, it can me marked as read-only because some condition prevents it from changing state (for example, the underlying resource is locked). While read-only models can never be changed, editable models can go in and out editable state during their life cycle.

isDirty

public boolean isDirty()

Tests whether the model has been changed from the last clean state.

save

public void save(java.io.PrintWriter writer)

Saves the model into the provided writer. The assumption is that the model can be persisted in an ASCII output stream (for example, an XML file). This method should clear the 'dirty' flag when done.

setDirty

public void setDirty(boolean dirty)

Sets the dirty flag of the model. This method is normally not intended to be used outside the model. Most often, a dirty model should be saved to clear the flag.