oracle.ide.palette
Interface PalettePage

All Superinterfaces:

Data, Displayable, Element, Folder

public interface PalettePage

extends Folder

Method Summary

void	addPaletteItem(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) Add a palette item to the Palette Page
boolean	canShow() Returns true if palette page can display itself.
boolean	getCanRemove() Returns if this page can be removed by the user.
boolean	getDraggable() Return dnd.
java.lang.String	getName() Return the name of the page.
java.lang.String	getPageEditor() Return the PageEditor for this PalettePage
java.lang.String	getPaletteContext() Return the PaletteContext
java.util.ArrayList	getPaletteItems() Return list of the palette items contained within the page
java.lang.String	getProjectConfigurator() Return the project configurator for this PalettePage
java.lang.String	getShowForTypes() Get current type list
java.lang.String	getType() Return the main type( suffix ) that maps to this page
java.lang.String	getView() Return the current view
boolean	isPersistent() Return true if page info should be persisted
void	setCanRemove(boolean canRemove) Set if this page can be removed by the users
void	setCanShow(boolean canShow) Set whether to allow the palette page to display itself.
void	setDraggable(boolean draggable) Sets if the all palette items belonging to this page can be dragged.
void	setIsPersistent(boolean isPersistent) Set whether to save information during shutdown.
void	setName(java.lang.String name) Set the name of the page.
void	setPageEditor(java.lang.String pageEditor) Set the PageEditor for this Palette Page
void	setPaletteContext(java.lang.String paletteContextClass) Set the PaletteContext
void	setProjectConfigurator(java.lang.String pc) Set the project configuration for this PalettePage
void	setShowForTypes(java.lang.String types) Set which page types to show this page for.
void	setType(java.lang.String type) Set the main type( suffix ) to map this page to.
void	setView(java.lang.String view) Set the main view( list or icon ) for this page.

Methods inherited from interface oracle.ide.model.Folder

add, canAdd, canRemove, containsChild, remove, removeAll, size

Methods inherited from interface oracle.ide.model.Element

getAttributes, getChildren, mayHaveChildren

Methods inherited from interface oracle.ide.model.Data

getData

Methods inherited from interface oracle.ide.model.Displayable

getIcon, getLongLabel, getShortLabel, getToolTipText, toString

Method Detail

getPaletteItems

public java.util.ArrayList getPaletteItems()

Return list of the palette items contained within the page

Returns:

List of palette items.

addPaletteItem

public void addPaletteItem(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)

Add a palette item to the Palette Page

Parameters:

icon - URL of Icon for palette to display

info - Extra information associated with item

longLabel - Tooltip info

shortLabel - Generally used as the display name.

type - Type of palette item( java, jsp, html, etc. )

editor - Editor associated with item which will be invoked.

library - All libraries that should be added to project when item is pressed.

isPersistent

public boolean isPersistent()

Return true if page info should be persisted

setIsPersistent

public void setIsPersistent(boolean isPersistent)

Set whether to save information during shutdown.

canShow

public boolean canShow()

Returns true if palette page can display itself.

setCanShow

public void setCanShow(boolean canShow)

Set whether to allow the palette page to display itself.

setShowForTypes

public void setShowForTypes(java.lang.String types)

Set which page types to show this page for. ex. jsp;xml;html;htm

getShowForTypes

public java.lang.String getShowForTypes()

Get current type list

Returns:

types

setName

public void setName(java.lang.String name)

Set the name of the page.

Parameters:

name - of page.

getName

public java.lang.String getName()

Return the name of the page.

setPaletteContext

public void setPaletteContext(java.lang.String paletteContextClass)

Set the PaletteContext

getPaletteContext

public java.lang.String getPaletteContext()

Return the PaletteContext

setType

public void setType(java.lang.String type)

Set the main type( suffix ) to map this page to.

getType

public java.lang.String getType()

Return the main type( suffix ) that maps to this page

Returns:

the suffix mapped to this page.

setView

public void setView(java.lang.String view)

Set the main view( list or icon ) for this page.

getView

public java.lang.String getView()

Return the current view

Returns:

the current view

setCanRemove

public void setCanRemove(boolean canRemove)

Set if this page can be removed by the users

getCanRemove

public boolean getCanRemove()

Returns if this page can be removed by the user.

Returns:

true if this page can be removed.

setPageEditor

public void setPageEditor(java.lang.String pageEditor)

Set the PageEditor for this Palette Page

Parameters:

pageEditor -

getPageEditor

public java.lang.String getPageEditor()

Return the PageEditor for this PalettePage

setProjectConfigurator

public void setProjectConfigurator(java.lang.String pc)

Set the project configuration for this PalettePage

getProjectConfigurator

public java.lang.String getProjectConfigurator()

Return the project configurator for this PalettePage

Returns:

the ProjectConfigurator

setDraggable

public void setDraggable(boolean draggable)

Sets if the all palette items belonging to this page can be dragged.

Parameters:

draggable -

getDraggable

public boolean getDraggable()

Return dnd.

Returns:

true if all palette items can be dragged using dnd.