oracle.ide.palette
Interface PalettePage

All Superinterfaces:

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
PaletteItem	getPaletteItem(java.lang.String itemName) Retrieve PaletteItem by Item Name
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	getTechnologyScope() Return Technology Scope
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	setTechnologyScope(java.lang.String scope) Set Technology Scope
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, getData, mayHaveChildren

Methods inherited from interface oracle.ide.model.Displayable

getIcon, getLongLabel, getShortLabel, getToolTipText, toString

Method Detail

getPaletteItems

java.util.ArrayList getPaletteItems()

Return list of the palette items contained within the page

Returns:

List of palette items.

addPaletteItem

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

boolean - IsPersistent Used to persist item after shutdown.

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

boolean isPersistent()

Return true if page info should be persisted

setIsPersistent

void setIsPersistent(boolean isPersistent)

Set whether to save information during shutdown.

canShow

boolean canShow()

Returns true if palette page can display itself.

setCanShow

void setCanShow(boolean canShow)

Set whether to allow the palette page to display itself.

setShowForTypes

void setShowForTypes(java.lang.String types)

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

Parameters:

the - semi-colon delimited suffixes.

getShowForTypes

java.lang.String getShowForTypes()

Get current type list

Returns:

types

setName

void setName(java.lang.String name)

Set the name of the page.

Parameters:

name - of page.

getName

java.lang.String getName()

Return the name of the page.

setPaletteContext

void setPaletteContext(java.lang.String paletteContextClass)

Set the PaletteContext

Parameters:

the - paletteContext to use

getPaletteContext

java.lang.String getPaletteContext()

Return the PaletteContext

setType

void setType(java.lang.String type)

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

Parameters:

the - suffix to map this page to.

getType

java.lang.String getType()

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

Returns:

the suffix mapped to this page.

setView

void setView(java.lang.String view)

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

Parameters:

the - view for this page.

getView

java.lang.String getView()

Return the current view

Returns:

the current view

setCanRemove

void setCanRemove(boolean canRemove)

Set if this page can be removed by the users

Parameters:

false - if this page can be removed, defaults to true.

getCanRemove

boolean getCanRemove()

Returns if this page can be removed by the user.

Returns:

true if this page can be removed.

setPageEditor

void setPageEditor(java.lang.String pageEditor)

Set the PageEditor for this Palette Page

Parameters:

pageEditor -

getPageEditor

java.lang.String getPageEditor()

Return the PageEditor for this PalettePage

setProjectConfigurator

void setProjectConfigurator(java.lang.String pc)

Set the project configuration for this PalettePage

Parameters:

the - ProjectConfigurator to evaluate this page.

getProjectConfigurator

java.lang.String getProjectConfigurator()

Return the project configurator for this PalettePage

Returns:

the ProjectConfigurator

setDraggable

void setDraggable(boolean draggable)

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

Parameters:

draggable -

getDraggable

boolean getDraggable()

Return dnd.

Returns:

true if all palette items can be dragged using dnd.

getPaletteItem

PaletteItem getPaletteItem(java.lang.String itemName)

Retrieve PaletteItem by Item Name

Parameters:

itemName - Name of Item

setTechnologyScope

void setTechnologyScope(java.lang.String scope)

Set Technology Scope

Parameters:

scope -

getTechnologyScope

java.lang.String getTechnologyScope()

Return Technology Scope

Returns:

scope