...
Moduł favourites umożliwia wtyczką rejestrację własnych obiektów typu
Należy stworzyć klasę implementującą interfejs
, które odpowiedzialne są za dostarczanie:
- definicji elementów (także w postaci drzewa) - elementy, które wyświetlane są użytkownikowi podczas budowy zestawów
- obiektów renderujących - przygotowujących dane do wyświetlenia
Implementacja handler'a
W pierwszej kolejności należy stworzyć klasę implementującą interfejs :
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
public class ExampleFavouriteHandler implements FavouriteHandler {
@Override
public boolean supports(String type) {
return "test".equals(type) || "test-sub".equals(type);
}
@Override
public Collection<Definition> getDefinitions() {
List<Definition> definitions = new ArrayList<Definition>();
Definition definition = new Definition("test");
definition.setName("TEST - Nazwa");
definition.setDescription("TEST - Opis");
definition.setTypeDescription("TEST - Typ");
definition.setCountable(false);
definitions.add(definition);
NestedDefinition nestedDefinition = new NestedDefinition(definition.getType(), "test-sub");
nestedDefinition.setName("TEST-SUB - Nazwa");
nestedDefinition.setDescription("TEST-SUB - Opis");
nestedDefinition.setTypeDescription("TEST-SUB - Typ");
nestedDefinition.setCountable(true);
definitions.add(nestedDefinition);
return definitions;
}
@Override
public FavouritesRenderer getRenderer(FavouriteElement favourite) {
ExampleFavouriteRenderer renderer = new ExampleFavouriteRenderer();
renderer.setFavourite(favourite);
return renderer;
}
} |
Komentarze do pliku:
4-5: informujemy jakie typy definicji wspieramy - jesteśmy ich autorami i potrafimy je narysować
12-17: element ulubiony typu test
19-24: element ulubiony typu test-sub - jest on zagnieżdżony w elemencie test, co spowoduje stworzenie struktury drzewa z oknie wyboru
31-33: tworzymy obiekt, który narysuje podany element ulubionych.
| Tip |
|---|
Klasa handlera zdefiniowana w module <favourites> zostanie stworzona z wykorzystaniem kontekstu wtyczki, dzięki czemu możliwe jest standardowe korzystanie z adnotacji @Component. |
Powyższy kod definicji będzie skutkował dodaniem 2 nowych elementów ulubionych do wyboru w postaci drzewa:
Implementacja obiektu renderującego
Obiekt odpowiedzialny za narysowanie elementów w gadżecie to .
| Tip | ||
|---|---|---|
Istnieje obiekt pomocniczy który dostarcza domyślne zachowanie rysowania pozwalając na łatwe przeciążenie.
|
Implementacja takiego obiektu może wyglądać tak:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
public class ExampleFavouriteRenderer extends FavouritesRendererSupport {
@Override
public boolean shouldRender() {
return true;
}
} |
Deklaracja modułu <favourites>
Ostatnim krokiem jest deklaracja modułu <favoruites> w pliku suncode-plugin.xml:
| Code Block | ||||
|---|---|---|---|---|
| ||||
<favourites key="favourite-entry" handler="com.suncode.plugin.example.ExampleFavouriteHandler"/> |