Oracle Fusion Middleware Java API Reference for Oracle Extension SDK
11g Release 2 (11.1.2.0.0)

E17493-01

oracle.ide.palette2
Class PaletteGroup

java.lang.Object
  extended by oracle.ide.palette2.PaletteGroup
Direct Known Subclasses:
DefaultPaletteGroup

public abstract class PaletteGroup
extends java.lang.Object

Palette Group is the second level the Component Palette model and is the "child" of PalettePage. A Palette Group is a subcategory grouping within a PalettePage. Users know Palette Groups as the accordian windows displayed within the Component Palette UI. Palette Group consists of zero or more Palette Sections.

See Also:
Palette, PalettePage, PaletteSection, PaletteItem

Constructor Summary
PaletteGroup()
           
 
Method Summary
abstract  java.lang.Object getData(java.lang.Object key)
          Get data
abstract  java.lang.String getDescription()
          Get description.
abstract  javax.swing.Icon getIcon()
          Get Icon.
abstract  java.lang.String getName()
          Get display name.
abstract  java.util.Collection<PaletteSection> getSections()
          Get Palette Sections
abstract  boolean isVisible(Context context)
          Indicates whether or not a palette group should be visible based on the supplied context.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PaletteGroup

public PaletteGroup()
Method Detail

getSections

public abstract java.util.Collection<PaletteSection> getSections()
Get Palette Sections

Returns:
unmodifiable collection of PaletteSection's

getName

public abstract java.lang.String getName()
Get display name.

Returns:
display name.

getDescription

public abstract java.lang.String getDescription()
Get description.

Returns:
string.

getIcon

public abstract javax.swing.Icon getIcon()
Get Icon.

Returns:
Icon.

getData

public abstract java.lang.Object getData(java.lang.Object key)
Get data

Use to surface arbitrary additional data. This is used to identify the item to their clients without requiring clients to cast to a PaletteItem subclass.

For example, in XMLEF, use getData to get from a PaletteItem back to the identification of what type of element to create (XmlKey). XMLEF's PaletteItem instances will have this data.


isVisible

public abstract boolean isVisible(Context context)
Indicates whether or not a palette group should be visible based on the supplied context.

Parameters:
context - The active context
Returns:
true if the group should be visible

Oracle Fusion Middleware Java API Reference for Oracle Extension SDK
11g Release 2 (11.1.2.0.0)

E17493-01

Copyright © 1997, 2011, Oracle. All rights reserved.