org.formaria.editor.project.helper
Class ForCodeHelper

java.lang.Object
  extended by org.formaria.editor.project.helper.CodeHelper
      extended by org.formaria.editor.project.helper.ForCodeHelper

public class ForCodeHelper
extends CodeHelper

A code helper for inserting of 'for' loops

Copyright (c) Formaria Ltd., 2002-2003

$Revision: 1.4 $

License: see License.txt


Constructor Summary
ForCodeHelper()
           
 
Method Summary
 void doInsert(javax.swing.JEditorPane pane, javax.swing.text.Document d, javax.swing.text.Caret c, EditorProject currentProject, PageResource pageRes)
          Insert the new codes
 java.lang.String getCaption()
          Get the caption displayed on the popup menu
 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

ForCodeHelper

public ForCodeHelper()
Method Detail

register

public void register(java.util.HashMap<java.lang.String,CodeHelper> resources)
Description copied from class: CodeHelper
Register the helper. EditorProjectManager.getStaticResources() is an array of static resources and an instance of the helper should be added to this array

Overrides:
register in class CodeHelper

doInsert

public 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

Specified by:
doInsert in class CodeHelper
Throws:
javax.swing.text.BadLocationException

getCaption

public java.lang.String getCaption()
Get the caption displayed on the popup menu

Specified by:
getCaption in class CodeHelper
Returns:
the caption

getMnemonic

public java.lang.Integer getMnemonic()
Get the mnemonic key for this item

Specified by:
getMnemonic in class CodeHelper
Returns:
the mnemonic