oracle.ide.palette2.layouts

Class PaletteLayoutDescriptor.Manager

java.lang.Object

oracle.ide.palette2.layouts.PaletteLayoutDescriptor.Manager

Enclosing interface:

PaletteLayoutDescriptor

public static class PaletteLayoutDescriptor.Manager
extends java.lang.Object

The PaletteLayoutDescriptor.Manager class is used to access (add and retrieve) PaletteLayoutDescriptor instances. It will automatically discover any descriptor instances declared using the palette-layouts-hook hook.

Constructor Summary

Constructors

Constructor and Description
Manager()

Method Summary

Modifier and Type	Method and Description
static void	addLayoutDescriptor(PaletteLayoutDescriptor descriptor) Add the given layout descriptor.
static PaletteLayoutDescriptor	getLayoutDescriptor(java.lang.String id) Get the layout descriptor whose ID matches the given ID, if any.
static java.util.Set<java.lang.String>	getLayoutDescriptorKeys() Get the set of keys for the known layout descriptors.
static java.util.List<PaletteLayoutDescriptor>	getLayoutDescriptors() Get a list of all current layout descriptors.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Manager

public Manager()

Method Detail

addLayoutDescriptor

public static void addLayoutDescriptor(PaletteLayoutDescriptor descriptor)

Add the given layout descriptor. If the descriptor is null this method has no effect. If another layout descriptor with the same IDhas already been added, then it will be replaced with the given layout descriptor.

Parameters:

descriptor - the layout descriptor

getLayoutDescriptor

public static PaletteLayoutDescriptor getLayoutDescriptor(java.lang.String id)

Get the layout descriptor whose ID matches the given ID, if any.

Parameters:

id - the ID to match

Returns:

the layout descriptor whose IDmatches the given ID, or null if none is found

getLayoutDescriptors

public static java.util.List<PaletteLayoutDescriptor> getLayoutDescriptors()

Get a list of all current layout descriptors. The returned list will be a copy of the descriptors, so that modifications to the returned list will not affect this manager.

Returns:

a list of all current layout descriptors

getLayoutDescriptorKeys

public static java.util.Set<java.lang.String> getLayoutDescriptorKeys()

Get the set of keys for the known layout descriptors. The returned set will be unmodifiable.

Returns:

the set of keys for the known layout descriptors