org.netbeans.modules.web.spi.webmodule

Class WebModuleExtender

java.lang.Object

org.netbeans.modules.web.spi.webmodule.WebModuleExtender

public abstract class WebModuleExtender
extends Object

Provides support for extending a web module with a web framework, that is, it allows to modify the web module to make use of the framework.

Since:

1.9

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	WebModuleExtender.Savable Interface that represents ability to save WebModuleExtender properties for a WebModule.

Constructor Summary

Constructors

Constructor and Description
WebModuleExtender()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	addChangeListener(ChangeListener listener) Attaches a change listener that is to be notified of changes in the extender (e.g., the result of the isValid() method has changed.
abstract Set<FileObject>	extend(WebModule webModule) Called to extend the given web module with the web framework corresponding to this extender.
abstract JComponent	getComponent() Returns a UI component used to allow the user to customize this extender.
abstract HelpCtx	getHelp() Returns a help context for getComponent().
abstract boolean	isValid() Checks if this extender is valid (e.g., if the configuration set using the UI component returned by getComponent() is valid).
abstract void	removeChangeListener(ChangeListener listener) Removes a change listener.
abstract void	update() Called when the component returned by getComponent() needs to be filled with external data.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebModuleExtender

public WebModuleExtender()

Method Detail

addChangeListener

public abstract void addChangeListener(ChangeListener listener)

Attaches a change listener that is to be notified of changes in the extender (e.g., the result of the isValid() method has changed.

Parameters:

listener - a listener.

removeChangeListener

public abstract void removeChangeListener(ChangeListener listener)

Removes a change listener.

Parameters:

listener - a listener.

getComponent

public abstract JComponent getComponent()

Returns a UI component used to allow the user to customize this extender.

Returns:

a component or null if this extender does not provide a configuration UI. This method might be called more than once and it is expected to always return the same instance.

getHelp

public abstract HelpCtx getHelp()

Returns a help context for getComponent().

Returns:

a help context; can be null.

update

public abstract void update()

Called when the component returned by getComponent() needs to be filled with external data.

isValid

public abstract boolean isValid()

Checks if this extender is valid (e.g., if the configuration set using the UI component returned by getComponent() is valid).

Returns:

true if the configuration is valid, false otherwise.

extend

public abstract Set<FileObject> extend(WebModule webModule)

Called to extend the given web module with the web framework corresponding to this extender.

Parameters:

webModule - the web module to be extended; never null.

Returns:

the set of newly created files in the web module.