oracle.ide.palette2.layouts

Interface PaletteLayoutDescriptor

public interface PaletteLayoutDescriptor

The PaletteLayoutDescriptor interface defines the contract for an object that provides metadata about a particular PaletteLayout implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PaletteLayoutDescriptor.Manager The PaletteLayoutDescriptor.Manager class is used to access (add and retrieve) PaletteLayoutDescriptor instances.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	description() Get the description text of the described layout.
PaletteLayout	getLayoutInstance() Get an instance of the described PaletteLayout.
javax.swing.Icon	icon() Get the icon for the described layout.
java.lang.String	id() Get the unique identifier for the described layout.
java.lang.String	name() Get the name of the described layout.

Method Detail

id

java.lang.String id()

Get the unique identifier for the described layout. It is recommended to use Java-style naming to ensure the uniquness of this value.

Returns:

the unique identifier for the described layout

name

java.lang.String name()

Get the name of the described layout. The returned value should be a localized, human-readable string suitable for display to the user.

Returns:

the name of the described layout

description

java.lang.String description()

Get the description text of the described layout. The returned value should be a localized, human-readable string suitable for display to the user.

Returns:

the description text of the described layout

icon

javax.swing.Icon icon()

Get the icon for the described layout.

Returns:

the icon for the described layout

getLayoutInstance

PaletteLayout getLayoutInstance()

Get an instance of the described PaletteLayout.

Returns:

an instance of the described PaletteLayout