org.formaria.editor.project.helper
Class CodeHelper

java.lang.Object
  org.formaria.editor.project.helper.CodeHelper

Direct Known Subclasses:

ForCodeHelper, MemberReferenceCodeHelper, NavCodeHelper, PageCodeHelper

public abstract class CodeHelper
extends java.lang.Object

An abstract helper class to support definitions of code snippets

Copyright (c) Formaria Ltd., 2002-2003

$Revision: 1.4 $

License: see License.txt

Constructor Summary

CodeHelper()
Construct a new helper

Method Summary

abstract void	doInsert(javax.swing.JEditorPane pane, javax.swing.text.Document d, javax.swing.text.Caret c, EditorProject currentProject, PageResource pageRes) Insert the new codes
abstract java.lang.String	getCaption() Get the caption displayed on the popup menu
abstract java.lang.Integer	getMnemonic() Get the mnemonic key for this item
void	register(java.util.HashMap<java.lang.String,CodeHelper> resources) Register the helper.

Methods inherited from class java.lang.Object

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

Constructor Detail

CodeHelper

public CodeHelper()

Construct a new helper

Method Detail

register

public void register(java.util.HashMap<java.lang.String,CodeHelper> resources)

Register the helper. EditorProjectManager.getStaticResources() is an array of static resources and an instance of the helper should be added to this array

doInsert

public abstract void doInsert(javax.swing.JEditorPane pane,
                              javax.swing.text.Document d,
                              javax.swing.text.Caret c,
                              EditorProject currentProject,
                              PageResource pageRes)
                       throws javax.swing.text.BadLocationException

Insert the new codes

Throws:

javax.swing.text.BadLocationException

getCaption

public abstract java.lang.String getCaption()

Get the caption displayed on the popup menu

Returns:

the caption

getMnemonic

public abstract java.lang.Integer getMnemonic()

Get the mnemonic key for this item

Returns: