oracle.ide.palette2.layouts

Class PaletteLayout<L extends java.awt.LayoutManager>

java.lang.Object

oracle.ide.palette2.layouts.PaletteLayout<L>

All Implemented Interfaces:

java.awt.event.KeyListener, java.awt.LayoutManager, java.awt.LayoutManager2, java.util.EventListener

public abstract class PaletteLayout<L extends java.awt.LayoutManager>
extends java.lang.Object
implements java.awt.LayoutManager2, java.awt.event.KeyListener

The PaletteLayout interface defines the contract for a class that can layout the items for a PaletteDockable2 implementation.

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	DEFAULT_SEPARATOR_HEIGHT
protected L	impl
static java.lang.Class<? extends oracle.ideimpl.palette2.PaletteGroupUI>	PALETTE_GROUP_UI_KEY The PALETTE_GROUP_UI_KEY is used to get a client property representing the PaletteGroupUI.
static java.lang.Class<? extends oracle.ideimpl.palette2.PaletteSectionUI>	PALETTE_SECTION_UI_KEY The PALETTE_SECTION_UI_KEY is used to get a client property representing the PaletteSectionUI.
protected static float	SEPARATOR_HEIGHT_FUDGE_FACTOR
protected static float	SEPARATOR_WIDTH_FUDGE_FACTOR

Constructor Summary

Constructors

Constructor and Description
PaletteLayout(L impl)

Method Summary

Methods

Modifier and Type	Method and Description
void	addLayoutComponent(java.awt.Component comp, java.lang.Object constraints)
void	addLayoutComponent(java.lang.String name, java.awt.Component comp)
protected abstract void	configurePaletteItemUI(oracle.ideimpl.palette2.PaletteItemUI itemUI)
protected abstract void	configurePaletteSectionUI(oracle.ideimpl.palette2.PaletteSectionUI sectionUI)
protected oracle.ideimpl.palette2.PaletteGroupUI	getGroupUI(javax.swing.JComponent component)
protected oracle.ideimpl.palette2.PaletteItemUI	getItemAbove(oracle.ideimpl.palette2.PaletteItemUI current) Get the item "above" the given item, meaning in the row directly above.
protected oracle.ideimpl.palette2.PaletteItemUI	getItemAfter(oracle.ideimpl.palette2.PaletteItemUI current) Get the item "after" the given item, meaning immediately adjacent on the right.
protected oracle.ideimpl.palette2.PaletteItemUI	getItemBefore(oracle.ideimpl.palette2.PaletteItemUI current) Get the item "before" the given item, meaning immediately adjacent on the left.
protected oracle.ideimpl.palette2.PaletteItemUI	getItemBelow(oracle.ideimpl.palette2.PaletteItemUI current) Get the item "below" the given item, meaning in the row directly below.
float	getLayoutAlignmentX(java.awt.Container target)
float	getLayoutAlignmentY(java.awt.Container target)
protected int	indexOf(oracle.ideimpl.palette2.PaletteItemUI itemUI)
void	invalidateLayout(java.awt.Container target)
void	keyPressed(java.awt.event.KeyEvent e)
void	keyReleased(java.awt.event.KeyEvent e)
void	keyTyped(java.awt.event.KeyEvent e)
void	layoutContainer(java.awt.Container parent) Subclasses that override this method are expected to call this implementation before finishing.
java.awt.Dimension	maximumLayoutSize(java.awt.Container target)
java.awt.Dimension	minimumLayoutSize(java.awt.Container parent)
java.awt.Dimension	preferredLayoutSize(java.awt.Container parent)
void	removeLayoutComponent(java.awt.Component comp)

Methods inherited from class java.lang.Object

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

Field Detail

PALETTE_GROUP_UI_KEY

public static java.lang.Class<? extends oracle.ideimpl.palette2.PaletteGroupUI> PALETTE_GROUP_UI_KEY

The PALETTE_GROUP_UI_KEY is used to get a client property representing the PaletteGroupUI.

PALETTE_SECTION_UI_KEY

public static java.lang.Class<? extends oracle.ideimpl.palette2.PaletteSectionUI> PALETTE_SECTION_UI_KEY

The PALETTE_SECTION_UI_KEY is used to get a client property representing the PaletteSectionUI.

SEPARATOR_HEIGHT_FUDGE_FACTOR

protected static final float SEPARATOR_HEIGHT_FUDGE_FACTOR

See Also:

Constant Field Values

SEPARATOR_WIDTH_FUDGE_FACTOR

protected static final float SEPARATOR_WIDTH_FUDGE_FACTOR

See Also:

Constant Field Values

DEFAULT_SEPARATOR_HEIGHT

protected static final int DEFAULT_SEPARATOR_HEIGHT

See Also:

Constant Field Values

impl

protected L extends java.awt.LayoutManager impl

Constructor Detail

PaletteLayout

public PaletteLayout(L impl)

Method Detail

addLayoutComponent

public void addLayoutComponent(java.awt.Component comp,
                      java.lang.Object constraints)

Specified by:

addLayoutComponent in interface java.awt.LayoutManager2

getLayoutAlignmentX

public float getLayoutAlignmentX(java.awt.Container target)

Specified by:

getLayoutAlignmentX in interface java.awt.LayoutManager2

getLayoutAlignmentY

public float getLayoutAlignmentY(java.awt.Container target)

Specified by:

getLayoutAlignmentY in interface java.awt.LayoutManager2

invalidateLayout

public void invalidateLayout(java.awt.Container target)

Specified by:

invalidateLayout in interface java.awt.LayoutManager2

maximumLayoutSize

public java.awt.Dimension maximumLayoutSize(java.awt.Container target)

Specified by:

maximumLayoutSize in interface java.awt.LayoutManager2

addLayoutComponent

public void addLayoutComponent(java.lang.String name,
                      java.awt.Component comp)

Specified by:

addLayoutComponent in interface java.awt.LayoutManager

layoutContainer

public void layoutContainer(java.awt.Container parent)

Subclasses that override this method are expected to call this implementation before finishing.

Specified by:

layoutContainer in interface java.awt.LayoutManager

Parameters:

parent -

minimumLayoutSize

public java.awt.Dimension minimumLayoutSize(java.awt.Container parent)

Specified by:

minimumLayoutSize in interface java.awt.LayoutManager

preferredLayoutSize

public java.awt.Dimension preferredLayoutSize(java.awt.Container parent)

Specified by:

preferredLayoutSize in interface java.awt.LayoutManager

removeLayoutComponent

public void removeLayoutComponent(java.awt.Component comp)

Specified by:

removeLayoutComponent in interface java.awt.LayoutManager

configurePaletteItemUI

protected abstract void configurePaletteItemUI(oracle.ideimpl.palette2.PaletteItemUI itemUI)

configurePaletteSectionUI

protected abstract void configurePaletteSectionUI(oracle.ideimpl.palette2.PaletteSectionUI sectionUI)

keyPressed

public void keyPressed(java.awt.event.KeyEvent e)

Specified by:

keyPressed in interface java.awt.event.KeyListener

keyReleased

public void keyReleased(java.awt.event.KeyEvent e)

Specified by:

keyReleased in interface java.awt.event.KeyListener

keyTyped

public void keyTyped(java.awt.event.KeyEvent e)

Specified by:

keyTyped in interface java.awt.event.KeyListener

getItemAbove

protected oracle.ideimpl.palette2.PaletteItemUI getItemAbove(oracle.ideimpl.palette2.PaletteItemUI current)

Get the item "above" the given item, meaning in the row directly above. This method is called as a result of the user pressing the "up" arrow key when the given PaletteItemUI is in focus. This implementation simply returns the given PaletteItemUI.

Parameters:

current -

Returns:

the PaletteItemUI directly "above" the given PaletteItemUI in the component palette

getItemBelow

protected oracle.ideimpl.palette2.PaletteItemUI getItemBelow(oracle.ideimpl.palette2.PaletteItemUI current)

Get the item "below" the given item, meaning in the row directly below. This method is called as a result of the user pressing the "down" arrow key when the given PaletteItemUI is in focus. This implementation simply returns the given PaletteItemUI.

Parameters:

current -

Returns:

the PaletteItemUI directly "below" the given PaletteItemUI in the component palette

getItemBefore

protected oracle.ideimpl.palette2.PaletteItemUI getItemBefore(oracle.ideimpl.palette2.PaletteItemUI current)

Get the item "before" the given item, meaning immediately adjacent on the left. This method is called as a result of the user pressing the "left" arrow key when the given PaletteItemUI is in focus. This implementation returns the PaletteItemUI whose position/index is one before the given item. If the given item is the first item, then it will be returned.

Parameters:

current -

Returns:

the PaletteItemUI directly "before" the given PaletteItemUI in the component palette

getItemAfter

protected oracle.ideimpl.palette2.PaletteItemUI getItemAfter(oracle.ideimpl.palette2.PaletteItemUI current)

Get the item "after" the given item, meaning immediately adjacent on the right. This method is called as a result of the user pressing the "right" arrow key when the given PaletteItemUI is in focus. This implementation returns the PaletteItemUI whose position/index is one aftger the given item. If the given item is the last item, then it will be returned.

Parameters:

current -

Returns:

the PaletteItemUI directly "after" the given PaletteItemUI in the component palette

indexOf

protected int indexOf(oracle.ideimpl.palette2.PaletteItemUI itemUI)

getGroupUI

protected oracle.ideimpl.palette2.PaletteGroupUI getGroupUI(javax.swing.JComponent component)