org.netbeans.spi.palette

Annotation Type PaletteItemRegistration

@Retention(value=SOURCE)
 @Target(value={TYPE,PACKAGE})
public @interface PaletteItemRegistration

Register a palette item. This annotation may be used at two level:

• at package level body MUST be set;
  
  Usage example in a package-info.java file, inspired by Netbeans Code Snippet Module Tutorial.
  @PaletteItemRegistration(paletteid = "HTMLPalette", category = "HTML", itemid = "BR", icon32 = "org/netbeans/modules/newsnippets1/BR32.png", icon16 = "org/netbeans/modules/newsnippets1/BR16.png", body = "<br>", name = "New Line", tooltip = "<br>")
• at class level on class implementing ActiveEditorDrop.
  
  @PaletteItemRegistration( paletteid = "HTMLPalette", category = "HTML", itemid = "BR", icon32 = "org/netbeans/modules/newsnippets1/BR32.png", icon16 = "org/netbeans/modules/newsnippets1/BR16.png", body = "<br>", name = "New Line", tooltip = "<br>")
public class MyPaletteItem implements org.openide.text.ActiveEditorDrop ...

Since:

1.40

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	category Category for palette item.
String	icon16 Path to a 16x16 image file for palette item.
String	icon32 Path to a 32x32 image file for palette item.
String	itemid Id for palette item.
String	name Display name for palette item.
String	paletteid Palette root name.
String	tooltip Tooltip text for palette item.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	body body of palette item.

Element Detail

paletteid

public abstract String paletteid

Palette root name. This is part of palette location in the netbeans layer:
paletteid/category/itemid

category

public abstract String category

Category for palette item. This is part of palette location in the netbeans layer:
paletteid/category/itemid

itemid

public abstract String itemid

Id for palette item. This is part of palette location in the netbeans layer:
paletteid/category/itemid

icon16

public abstract String icon16

Path to a 16x16 image file for palette item.
Image must be available in classpath.

icon32

public abstract String icon32

Path to a 32x32 image file for palette item.
Image must be available in the classpath

name

public abstract String name

Display name for palette item.

tooltip

public abstract String tooltip

Tooltip text for palette item.

body

public abstract String body

body of palette item.

Default:

""