com.actional.ui.plugin

Interface ISettingDescriber

public interface ISettingDescriber

Optional plug-in interface that can be implemented by plug-ins in order to declare a set of plug-in settings and related metadata. Based on this data, the UIs for populating the settings and displaying the current states can be inferred and the user data validated as needed.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ISettingDescriber.IProvideMetadataContext

Method Summary

Modifier and Type	Method and Description
void	provideMetadata(ISettingDescriber.IProvideMetadataContext ctx) This method is called prior to calling describe() or generate().

Method Detail

provideMetadata

void provideMetadata(ISettingDescriber.IProvideMetadataContext ctx)
              throws java.lang.Exception

This method is called prior to calling describe() or generate(). It allows the plug-in to provide meta data that may be used by the rendering engine to enhance or customize the rendering of the plug-in's HTML GUI.

Parameters:

ctx - The ISettingDescriber.IProvideMetadataContext for this method

Throws:

java.lang.Exception