oracle.ide.palette
Class PaletteManager

java.lang.Object
  oracle.ide.palette.PaletteManager

All Implemented Interfaces:

Module

public abstract class PaletteManager

extends java.lang.Object

implements Module

Palette manager.

Constructor Summary

PaletteManager()

Method Summary

abstract void	activateItem(PaletteItem item, boolean stickyMode) Activate Item in the component palette.
abstract void	addPaletteDisplayableListener(PaletteDisplayableListener listener) Add a PaletteDisplayableListener to allow users to do post visible operations to the palette.
abstract void	addPaletteItem(java.lang.String pageName, java.lang.String icon, java.lang.String info, boolean isPersistent, java.lang.String longLabel, java.lang.String shortLabel, java.lang.String type, java.lang.String editor, java.lang.String library, java.lang.String helpable, boolean updatePaletteUI) Add a palette item to a palette page.
abstract void	addPaletteListener(PaletteListener listener) Register a palette listener
abstract PaletteItem	getItemFromPage(java.lang.String itemName, java.lang.String pageName) Retrieve PaletteItem from the specified PalettePage
abstract PalettePage	getPage(java.lang.String pageName) Returns the palette page by name.
abstract Palette	getPalette() Retrieve the current palette model.
static PaletteManager	getPaletteManager() Returns the PaletteManager instance that is active in the IDE.
abstract java.util.Iterator	getPalettePagesByType(java.lang.String type) Retrieve all palette pages mapped to type.
abstract PaletteWindow	getPaletteWindow() Retrieves the current Palette View
abstract void	markDirty(boolean dirty) Mark the palette dirty or not!
abstract void	registerPaletteWizard(java.lang.String type, Invokable wizard) Register Invokable wizard.
abstract boolean	removePage(java.lang.String pageName) Remove page from palette
abstract void	removePaletteDisplayableListener(PaletteDisplayableListener listener) Remove a PaletteDisplayableListener
abstract void	removePaletteItem(java.lang.String pageName, java.lang.String itemName, boolean updatePaletteUI) This will remove a palette item from specified page.
abstract void	removePaletteListener(PaletteListener listener) Remove a palette listener
abstract void	resetPalette() Reset the palette.
abstract void	setPageAsDefault(java.lang.String documentSuffix, java.lang.String palettePage) Set page as default for editor type
static void	setPaletteManager(PaletteManager paletteManager) Publishes the specified PaletteManager as the active instance in the IDE.
abstract boolean	showPalettePage(java.lang.String pageName) Show palette page.
abstract void	syncPalette(Context context) Force a palette sync with current context.
abstract void	updatePaletteUI() Update the PaletteUI to represent the current model.

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.javatools.Module

initialize

Constructor Detail

PaletteManager

public PaletteManager()

Method Detail

getPaletteManager

public static PaletteManager getPaletteManager()

Returns the PaletteManager instance that is active in the IDE.

setPaletteManager

public static void setPaletteManager(PaletteManager paletteManager)

Publishes the specified PaletteManager as the active instance in the IDE.

getPaletteWindow

public abstract PaletteWindow getPaletteWindow()

Retrieves the current Palette View

getPalette

public abstract Palette getPalette()

Retrieve the current palette model.

registerPaletteWizard

public abstract void registerPaletteWizard(java.lang.String type,
                                           Invokable wizard)

Register Invokable wizard.

Parameters:

type - - examples would be jsp, java, html, js, xml. All document suffixes.

wizard - - the wizard which implements Invokable.

See Also:

Invokable

getPage

public abstract PalettePage getPage(java.lang.String pageName)

Returns the palette page by name.

Returns:

PalettePage / null if no page found.

removePage

public abstract boolean removePage(java.lang.String pageName)

Remove page from palette

Parameters:

pageName - - name of page to remove from palette

showPalettePage

public abstract boolean showPalettePage(java.lang.String pageName)

Show palette page.

Parameters:

pageName - - name of page to show while IDE is running.

setPageAsDefault

public abstract void setPageAsDefault(java.lang.String documentSuffix,
                                      java.lang.String palettePage)

Set page as default for editor type

Parameters:

documentSuffix - - the document type or suffix to be default for. ex. ( jsp )

palettePage - - the name of the palette page to show when document is opened.

resetPalette

public abstract void resetPalette()

Reset the palette. If stickyMode has been set, it will be removed.

activateItem

public abstract void activateItem(PaletteItem item,
                                  boolean stickyMode)

Activate Item in the component palette.

Parameters:

item - - the palette item to activate.

stickyMode - - set if stickyMode should turned on.

getItemFromPage

public abstract PaletteItem getItemFromPage(java.lang.String itemName,
                                            java.lang.String pageName)

Retrieve PaletteItem from the specified PalettePage

Parameters:

itemName - - the shortLabel of the PaletteItem

pageName - - the shortLabel of the PalettePage

Returns:

PaletteItem

markDirty

public abstract void markDirty(boolean dirty)

Mark the palette dirty or not!

syncPalette

public abstract void syncPalette(Context context)

Force a palette sync with current context.

addPaletteItem

public abstract void addPaletteItem(java.lang.String pageName,
                                    java.lang.String icon,
                                    java.lang.String info,
                                    boolean isPersistent,
                                    java.lang.String longLabel,
                                    java.lang.String shortLabel,
                                    java.lang.String type,
                                    java.lang.String editor,
                                    java.lang.String library,
                                    java.lang.String helpable,
                                    boolean updatePaletteUI)

Add a palette item to a palette page.

Parameters:

pageName - the page to add item to.

icon - the string rep. url of the icon.

info - current item info.

isPersistent - - true if you the item to be persisted.

longLabel - - descriptive text of the item.

shortLabel - - the items visible name.

type - - the type of tag( ex. jsptag, java )

editor - - the invokable editor to use when activated.

library - - any libraries belonging to this item.

helpable - - the helpId

updatePaletteUI - true if you want the PaletteUI to update itself.

removePaletteItem

public abstract void removePaletteItem(java.lang.String pageName,
                                       java.lang.String itemName,
                                       boolean updatePaletteUI)

This will remove a palette item from specified page.

Parameters:

pageName - the page the item belongs to.

itemName - the shortlabel of the item.

updatePaletteUI - true if you want the PaletteUI to be updated.

updatePaletteUI

public abstract void updatePaletteUI()

Update the PaletteUI to represent the current model. This will check to make sure the palette is visible and will update the active panel.

addPaletteListener

public abstract void addPaletteListener(PaletteListener listener)

Register a palette listener

removePaletteListener

public abstract void removePaletteListener(PaletteListener listener)

Remove a palette listener

addPaletteDisplayableListener

public abstract void addPaletteDisplayableListener(PaletteDisplayableListener listener)

Add a PaletteDisplayableListener to allow users to do post visible operations to the palette. Examples would be showing a different page, removing pages, etc.

Parameters:

listener - the listener to add

removePaletteDisplayableListener

public abstract void removePaletteDisplayableListener(PaletteDisplayableListener listener)

Remove a PaletteDisplayableListener

Parameters:

listener - the listener to remove

getPalettePagesByType

public abstract java.util.Iterator getPalettePagesByType(java.lang.String type)

Retrieve all palette pages mapped to type.