com.japisoft.xmlappkit.editor
Class AbstractXMLEditor

java.lang.Object
  com.japisoft.xmlappkit.editor.AbstractXMLEditor

All Implemented Interfaces:

XMLEditor

Direct Known Subclasses:

Group1Editor, SourceXMLEditor

public abstract class AbstractXMLEditor

extends java.lang.Object

implements XMLEditor

Set of facility for creating a new XML editor. Call the setView method for resetting the view of your editor. You will have to implant the start and stop method

Version:

1.0

Author:

(c) 2004 JAPISoft / http://www.japisoft.com

Constructor Summary

AbstractXMLEditor(java.lang.String name)

Method Summary

XMLEditorActions	getActions()
XMLEditingChoice	getEditingChoice()
XMLEditorListeners	getListeners()
java.lang.String	getName()
XMLEditorUI	getView() One important feature.
void	init() This is called once for initializing the editor
void	setEnabled(boolean enabled) Here a way for enabling/disabling this editor, the UI part can ignore this state

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.japisoft.xmlappkit.editor.XMLEditor

start, stop

Constructor Detail

AbstractXMLEditor

public AbstractXMLEditor(java.lang.String name)

Parameters:

name - Required name of this editor

Method Detail

init

public void init()

Description copied from interface: XMLEditor

This is called once for initializing the editor

Specified by:

init in interface XMLEditor

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: XMLEditor

Here a way for enabling/disabling this editor, the UI part can ignore this state

Specified by:

setEnabled in interface XMLEditor

getName

public java.lang.String getName()

Specified by:

getName in interface XMLEditor

Returns:

the name of this editor

getView

public XMLEditorUI getView()

Description copied from interface: XMLEditor

One important feature. This view reference should'nt change during the XMLEditor life time meaning once you have built your view, always return the same object reference, so you must'nt rebuild this view each time this is asked

Specified by:

getView in interface XMLEditor

Returns:

the visible part of this editor. This is the view for the final user

getEditingChoice

public XMLEditingChoice getEditingChoice()

Specified by:

getEditingChoice in interface XMLEditor

Returns:

the set of element that this editor wants to support. If a null value is returned, it means this editor managed any nodes

getActions

public XMLEditorActions getActions()

Specified by:

getActions in interface XMLEditor

Returns:

a set of available actions. This editor can return null if it doesn't manage actions

getListeners

public XMLEditorListeners getListeners()

Specified by:

getListeners in interface XMLEditor

Returns:

a set of listeners. This editor can return null if it doesn't manage listeners