org.netbeans.modules.web.api.webmodule
Class ExtenderController

java.lang.Object
  org.netbeans.modules.web.api.webmodule.ExtenderController

public class ExtenderController
extends Object

This class allows a WebModuleExtender to communicate with its environment.

Since:

1.9

Nested Class Summary

static class

ExtenderController.Properties Encapsulates the properties of an ExtenderController, which are arbitrary Object values with a String name.

Method Summary

static ExtenderController	create() Creates a new controller.
String	getErrorMessage() Gets the error message for this controller.
ExtenderController.Properties	getProperties() Returns the properties of this controller.
void	setErrorMessage(String errorMessage) Sets an error message for this controller, which creator of the controller may use to e.g.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static ExtenderController create()

Creates a new controller.

Returns:

a new controller.

getErrorMessage

public String getErrorMessage()

Gets the error message for this controller.

Returns:

the error message or null if there is no error message.

setErrorMessage

public void setErrorMessage(String errorMessage)

Sets an error message for this controller, which creator of the controller may use to e.g. display it in the UI.

Parameters:

errorMessage - the error message; can be null if there is no error message.

getProperties

public ExtenderController.Properties getProperties()

Returns the properties of this controller. This allows the creator of the controller to communicate with the extenders. Usually the creator of the controller will set some properties and then call WebModuleExtender.update() to let the extender know that the properties have changed.

Returns:

an instance of ExtenderController.Properties; never null.