Widget Component SDK

AggreGate Widget Component SDK is a part of AggreGate SDK that allows to implement AggreGate widget components in Java programming language.

AggreGate Widget Component is a special type of AggreGate plugin. Technically, it includes at least five elements:

  • Main Plugin Class extends ComponentPlugin class. This is a main plugin class that provide access to component classes.

  • Component Class extends WAbstractComponent class. It contains component properties.

  • Context Class extends WAbstractContext class. This class represents widget component as context.

  • Renderer Class extends DefaultSwingComponentRenderer class. Renderer Class is used to represent widget component in Swing style.

  • Component plugin descriptor that defines component plugin properties and its place in AggreGate Server or AggreGate Client plugins hierarchy.

AggreGate SDK bundle includes an open-source example of AggreGate Widget Component implementation called Custom Progress Bar. It is located in examples.component package and comprises seven files:

  • CustomProgressBar.java - Main Plugin Class source code

  • CustomProgressBarSwingRenderer.java - Renderer Class source code

  • WCustomProgressBar.java - Component Class source code

  • WCustomProgressBarContext.java - Context Class source code

  • gb_custom_progress_bar.png - component icon

  • plugin.properties - component plugin descriptor

  • build.gradle - Gradle build file with a single task building component JAR file

To try the driver:

  • Run build.gradle using Gradle to build custom-progress-bar.jar

  • Copy custom-progress-bar.jar to %AggreGate Server Installation Folder/plugins/component when AggreGate Server is not running

  • Copy custom-progress-bar.jar to %AggreGate Client Installation Folder/plugins/component when AggreGate Client is not running

  • Start AggreGate Server and AggreGate Client

  • Create new widget and edit it via GUI Builder

  • Find new component in Custom Components toolbar tab

Was this page helpful?