oracle.jdeveloper.jsp
Class WebDocumentWizardNewFilePanelExtension

java.lang.Object
  oracle.jdeveloper.jsp.WebDocumentWizardNewFilePanelExtension

Direct Known Subclasses:

JspWizardNewFilePanelExtension

public abstract class WebDocumentWizardNewFilePanelExtension
extends java.lang.Object

An extension mechanism for the WebDocumentWizard's NewFile Panel. An instance of this class's implementation will be created each time a new file panel is initialized.

Nested Class Summary

static class

WebDocumentWizardNewFilePanelExtension.LayoutHint LayoutHint is used to make the group or section for placing the extension GUI components.

Field Summary

static float	WEIGHT_FIRST_COMPONENT The value used to specify the top-most component in the section.
static float	WEIGHT_LAST_COMPONENT The value used to specify the bottom-most component in the section.
static float	WEIGHT_UNDEFINED The undefined, or default weight.

Constructor Summary

WebDocumentWizardNewFilePanelExtension()

Method Summary

abstract javax.swing.JComponent	getGUI() Returns the GUI addition to the new file panel.
java.lang.String	getHeaderDescription() Returns the HTML text to be added to the HeaderDescription area at the top of the Dialog.
java.util.Map<java.lang.String,javax.swing.Action>	getHeaderHintTextActions() Registers action for use in hyperlinks included in the text of this hint label.
WebDocumentWizardNewFilePanelExtension.LayoutHint	getLayoutHint()
float	getWeight() Returns the weight of this extension.
void	onEntry(TraversableContext traversableContext)
void	onExit(TraversableContext traversableContext)
abstract void	postNodeCreationHook(Context context, WebDocumentNode webDocumentNode) The WebDocumentNode has been created and inital code generation has occurred, modify the XmlModel here.
static void	sortByWeight(java.util.List<? extends WebDocumentWizardNewFilePanelExtension> l) Sort the list of HtmlWizardNewFilePanelExtension based on their weight.
abstract boolean	supportsWizardID(java.lang.String wizardID) Returns true if the specified wizard id is supported.

Methods inherited from class java.lang.Object

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

Field Detail

WEIGHT_FIRST_COMPONENT

public static final float WEIGHT_FIRST_COMPONENT

The value used to specify the top-most component in the section. The section is marked by the LayoutHint. The value is Float.MIN_VALUE

See Also:

Constant Field Values

WEIGHT_UNDEFINED

public static final float WEIGHT_UNDEFINED

The undefined, or default weight. The value is .001 less than Float.MAX_VALUE. Extensions using this value will be added just before the last component in the section.

See Also:

Constant Field Values

WEIGHT_LAST_COMPONENT

public static final float WEIGHT_LAST_COMPONENT

The value used to specify the bottom-most component in the section. The section is marked by the LayoutHint.

See Also:

Constant Field Values

Constructor Detail

WebDocumentWizardNewFilePanelExtension

public WebDocumentWizardNewFilePanelExtension()

Method Detail

supportsWizardID

public abstract boolean supportsWizardID(java.lang.String wizardID)

Returns true if the specified wizard id is supported. No modifications to the wizard will occur if false is returned.

Parameters:

wizardID - The id of the wizard being invoked.

Returns:

true if the specified wizard id is supported

getGUI

public abstract javax.swing.JComponent getGUI()

Returns the GUI addition to the new file panel.

Returns:

the GUI addition to the new file panel

onEntry

public void onEntry(TraversableContext traversableContext)

Parameters:

traversableContext -

onExit

public void onExit(TraversableContext traversableContext)
            throws TraversalException

Parameters:

traversableContext -

Throws:

TraversalException

postNodeCreationHook

public abstract void postNodeCreationHook(Context context,
                                          WebDocumentNode webDocumentNode)

The WebDocumentNode has been created and inital code generation has occurred, modify the XmlModel here.

Parameters:

context - The context in which it was created

webDocumentNode - The source node created

getLayoutHint

public WebDocumentWizardNewFilePanelExtension.LayoutHint getLayoutHint()

getWeight

public float getWeight()

Returns the weight of this extension. The weight is used to place the gui component in the JSP dialog to which this extension is added. The extension could be added to 3 sections, above the IS_XML_CHECKBOX or below it or at the bottom of all checkboxes, based on getLayoutHint(). Then, the components are positioned in each section based on their weights. Extension components with lesser weights are placed above the ones with higher weights. By default this method will return WEIGHT_UNDEFINED, which will place the components just above the last component in the section.

See Also:

getLayoutHint()

getHeaderDescription

public java.lang.String getHeaderDescription()

Returns the HTML text to be added to the HeaderDescription area at the top of the Dialog. By default this method returns null.

getHeaderHintTextActions

public java.util.Map<java.lang.String,javax.swing.Action> getHeaderHintTextActions()

Registers action for use in hyperlinks included in the text of this hint label. The Map should have string id of the action as key and the action as value. Any "http:" hyperlink in the HTML text will trigger the registered action.

For example, if the description contains test, then the actual path of the url will be the id ("test") and the action may open a JDEV Help dialog.

By default this method returns null.

sortByWeight

public static final void sortByWeight(java.util.List<? extends WebDocumentWizardNewFilePanelExtension> l)

Sort the list of HtmlWizardNewFilePanelExtension based on their weight.

Parameters:

l - list of HtmlWizardNewFilePanelExtension to be sorted.