InsertWizard Class
- public abstract class InsertWizard
extends Object
Defines the interface for wizards that are invoked by palette items
when dropped or inserted from the palette onto a JSP or HTML page.
Related Topics
PaletteItem
-
Hierarchy
-
Object
InsertWizard
Methods from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
InsertWizard
public InsertWizard()
- Default constructor.
invoke(IDOMNode, IDOMNode) Method
DEPRECATED
public void invoke(IDOMNode
nodeParent,
IDOMNode
nodeRefChild)
This method has been deprecated in favor of
( InsertWizard.invokeWizard(IDOMNode, IDOMNode)
.
Parameters
-
nodeParent
- The parent of the drop point.
-
nodeRefChild
- The drop point which should be passed to
IDOMNode.insertBefore(IDOMNode, IDOMNode)
invokeWizard(IDOMNode, IDOMNode) Method
public IDOMDocument
invokeWizard(IDOMNode
nodeParent,
IDOMNode
nodeRefChild)
Called to invoke the insert wizard.
Override this method to implement an insert wizard. The insert wizard
may present UI to the user, and based on that decide what to insert
into the document. It may insert elements into the document at places
other than the insertion point that the user dropped.
This function may return a document fragment. If it does, then the
contents of that document will be inserted into the user's document at
the correct location. This method should return null if the user
cancelled the wizard, or if the wizard already has inserted the
appropriate markup into the document.
Wizards should never return a document fragment after modifying the
drop point referred to by nodeRefChild and nodeParent.
Doing so can cause undesired insertion behavior by the JSP designer
as it cannot always tell when the drop point has been modified.
The returned document fragment should be constructed by calling
nodeParent.getOwnerDocument().createCompatibleDocument()
to ensure an appropriate document is returned.
Parameters
-
nodeParent
- The parent of the drop point.
-
nodeRefChild
- The drop point which should be passed to
IDOMNode.insertBefore(IDOMNode, IDOMNode)
Returns
- A document containing what should be inserted, or null.
setTagInfo(TagInfo) Method
public void setTagInfo(TagInfo
tagInfo)
Sets the associated tag information for the Wizard.
Default behavior does nothing.
Parameters
-
tagInfo
- Associated tag's TagInfo object.