public interface WidgetDescriptor
The built-in set of legacy widgets (FILL-IN, TEXT, BROWSE, etc.) can be extended with 3rd party widget implementations. The implementations will typically exist in separate Java projects, outside of the FWD project. This interface provides structure to describe such an external widget.
Modifier and Type | Method and Description |
---|---|
default java.lang.Class<? extends ComObject> |
getCOMClass()
Returns optional COM class.
|
default java.lang.String |
getCOMName()
Returns optional COM name.
|
java.lang.Class<? extends WidgetConfig> |
getConfigClass()
Returns widget configuration class.
|
java.lang.Class<? extends Widget<?>> |
getImplClass()
Returns client-side widget implementation class.
|
java.lang.Class<? extends GenericWidget<?>> |
getResourceClass()
Returns widget server resource class.
|
java.lang.String |
getResourceName()
Returns widget resource name.
|
default void |
initializeClient(Session session)
Initialize the client after the session established.
|
java.lang.Class<? extends WidgetConfig> getConfigClass()
WidgetConfig
. A valid value is required for a minimal valid widget descriptor.java.lang.String getResourceName()
java.lang.Class<? extends GenericWidget<?>> getResourceClass()
GenericWidget
. A
valid value is needed for a minimal valid widget descriptor.java.lang.Class<? extends Widget<?>> getImplClass()
Widget
. A
valid value is needed for a minimal valid widget descriptor.default java.lang.String getCOMName()
ComServer.registerComObject(java.lang.String, java.lang.Class<? extends com.goldencode.p2j.comauto.ComObject>)
.
Default implementation returns null
meaning no COM API is provided.default java.lang.Class<? extends ComObject> getCOMClass()
ComObject
. This is needed by widgets
that also provide legacy COM API. This value together with the COM name is passed to
ComServer.registerComObject(java.lang.String, java.lang.Class<? extends com.goldencode.p2j.comauto.ComObject>)
.
Default implementation returns null
meaning no COM API is provided.default void initializeClient(Session session)
session
- the session.