pivot.wtk.skin.terra
Class TerraMenuSkin

java.lang.Object
  extended by pivot.wtk.skin.ComponentSkin
      extended by pivot.wtk.skin.ContainerSkin
          extended by pivot.wtk.skin.terra.TerraMenuSkin
All Implemented Interfaces:
ComponentKeyListener, ComponentLayoutListener, ComponentListener, ComponentMouseButtonListener, ComponentMouseListener, ComponentMouseWheelListener, ComponentStateListener, ConstrainedVisual, ContainerListener, MenuListener, Skin, Visual

public class TerraMenuSkin
extends ContainerSkin
implements MenuListener

Menu skin.

Author:
gbrown

Nested Class Summary
 
Nested classes/interfaces inherited from class pivot.wtk.skin.ContainerSkin
ContainerSkin.IndexFocusTraversalPolicy
 
Nested classes/interfaces inherited from interface pivot.wtk.ComponentListener
ComponentListener.Adapter
 
Nested classes/interfaces inherited from interface pivot.wtk.ComponentStateListener
ComponentStateListener.Adapter
 
Nested classes/interfaces inherited from interface pivot.wtk.ComponentMouseListener
ComponentMouseListener.Adapter
 
Nested classes/interfaces inherited from interface pivot.wtk.ComponentMouseButtonListener
ComponentMouseButtonListener.Adapter
 
Nested classes/interfaces inherited from interface pivot.wtk.ComponentKeyListener
ComponentKeyListener.Adapter
 
Field Summary
 
Fields inherited from class pivot.wtk.skin.ComponentSkin
SHOW_TOOLTIP_TIMEOUT
 
Constructor Summary
TerraMenuSkin()
           
 
Method Summary
 Color getColor()
           
 Color getDisabledColor()
           
 Font getFont()
           
 Color getHighlightBackgroundColor()
           
 Color getHighlightColor()
           
 int getMargin()
           
 Color getMarginColor()
           
 int getPreferredHeight(int width)
          Returns the visual's preferred height given the provided width constraint.
 Dimensions getPreferredSize()
          Returns the visual's unconstrained preferred size.
 int getPreferredWidth(int height)
          Returns the visual's preferred width given the provided height constraint.
 int getSectionSpacing()
           
 Color getSeparatorColor()
           
 boolean getShowKeyboardShortcuts()
           
 void install(Component component)
          Associates a skin with a component.
 void itemInserted(Menu.Section section, int index)
          Called when a menu item has been inserted.
 void itemsRemoved(Menu.Section section, int index, Sequence<Menu.Item> removed)
          Called when menu items have been removed.
 void layout()
          If the component on which the skin is installed is a container, lays out the container's children.
 void paint(Graphics2D graphics)
          Paints the visual.
 void sectionInserted(Menu menu, int index)
          Called when a menu section has been inserted.
 void sectionsRemoved(Menu menu, int index, Sequence<Menu.Section> removed)
          Called when menu sections have been removed.
 void setColor(Color color)
           
 void setColor(String color)
           
 void setDisabledColor(Color disabledColor)
           
 void setDisabledColor(String disabledColor)
           
 void setFont(Font font)
           
 void setFont(String font)
           
 void setHighlightBackgroundColor(Color highlightBackgroundColor)
           
 void setHighlightBackgroundColor(String highlightBackgroundColor)
           
 void setHighlightColor(Color highlightColor)
           
 void setHighlightColor(String highlightColor)
           
 void setMargin(int margin)
           
 void setMarginColor(Color marginColor)
           
 void setSectionSpacing(int sectionSpacing)
           
 void setSeparatorColor(Color separatorColor)
           
 void setShowKeyboardShortcuts(boolean showKeyboardShortcuts)
           
 void uninstall()
          Dissociates a skin from a component.
 
Methods inherited from class pivot.wtk.skin.ContainerSkin
componentInserted, componentsRemoved, contextKeyChanged, focusTraversalPolicyChanged, getBackgroundColor, getBackgroundPaint, isFocusable, isOpaque, setBackgroundColor, setBackgroundColor, setBackgroundPaint, setBackgroundPaint
 
Methods inherited from class pivot.wtk.skin.ComponentSkin
cursorChanged, displayableChanged, enabledChanged, focusedChanged, getComponent, getHeight, getWidth, invalidateComponent, keyPressed, keyReleased, keyTyped, locationChanged, mouseClick, mouseDown, mouseMove, mouseOut, mouseOver, mouseUp, mouseWheel, parentChanged, preferredSizeChanged, repaintComponent, repaintComponent, repaintComponent, repaintComponent, setSize, sizeChanged, styleUpdated, tooltipTextChanged, visibleChanged
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TerraMenuSkin

public TerraMenuSkin()
Method Detail

install

public void install(Component component)
Description copied from interface: Skin
Associates a skin with a component.

Specified by:
install in interface Skin
Overrides:
install in class ContainerSkin
Parameters:
component - The component to which the skin is being attached.

uninstall

public void uninstall()
Description copied from interface: Skin
Dissociates a skin from a component.

Specified by:
uninstall in interface Skin
Overrides:
uninstall in class ContainerSkin

getPreferredWidth

public int getPreferredWidth(int height)
Description copied from interface: ConstrainedVisual
Returns the visual's preferred width given the provided height constraint.

Specified by:
getPreferredWidth in interface ConstrainedVisual
Overrides:
getPreferredWidth in class ContainerSkin
Parameters:
height - The height by which to constrain the preferred width, or -1 for no constraint.

getPreferredHeight

public int getPreferredHeight(int width)
Description copied from interface: ConstrainedVisual
Returns the visual's preferred height given the provided width constraint.

Specified by:
getPreferredHeight in interface ConstrainedVisual
Overrides:
getPreferredHeight in class ContainerSkin
Parameters:
width - The width by which to constrain the preferred height, or -1 for no constraint.

getPreferredSize

public Dimensions getPreferredSize()
Description copied from interface: ConstrainedVisual
Returns the visual's unconstrained preferred size.

Specified by:
getPreferredSize in interface ConstrainedVisual
Overrides:
getPreferredSize in class ComponentSkin

layout

public void layout()
Description copied from interface: Skin
If the component on which the skin is installed is a container, lays out the container's children.

Specified by:
layout in interface Skin

paint

public void paint(Graphics2D graphics)
Description copied from interface: Visual
Paints the visual.

Specified by:
paint in interface Visual
Overrides:
paint in class ContainerSkin
Parameters:
graphics - The graphics context in which to paint the visual.

getFont

public Font getFont()

setFont

public void setFont(Font font)

setFont

public final void setFont(String font)

getColor

public Color getColor()

setColor

public void setColor(Color color)

setColor

public final void setColor(String color)

getDisabledColor

public Color getDisabledColor()

setDisabledColor

public void setDisabledColor(Color disabledColor)

setDisabledColor

public final void setDisabledColor(String disabledColor)

getHighlightColor

public Color getHighlightColor()

setHighlightColor

public void setHighlightColor(Color highlightColor)

setHighlightColor

public final void setHighlightColor(String highlightColor)

getHighlightBackgroundColor

public Color getHighlightBackgroundColor()

setHighlightBackgroundColor

public void setHighlightBackgroundColor(Color highlightBackgroundColor)

setHighlightBackgroundColor

public final void setHighlightBackgroundColor(String highlightBackgroundColor)

getMarginColor

public Color getMarginColor()

setMarginColor

public void setMarginColor(Color marginColor)

getMargin

public int getMargin()

setMargin

public void setMargin(int margin)

getSeparatorColor

public Color getSeparatorColor()

setSeparatorColor

public void setSeparatorColor(Color separatorColor)

getSectionSpacing

public int getSectionSpacing()

setSectionSpacing

public void setSectionSpacing(int sectionSpacing)

getShowKeyboardShortcuts

public boolean getShowKeyboardShortcuts()

setShowKeyboardShortcuts

public void setShowKeyboardShortcuts(boolean showKeyboardShortcuts)

sectionInserted

public void sectionInserted(Menu menu,
                            int index)
Description copied from interface: MenuListener
Called when a menu section has been inserted.

Specified by:
sectionInserted in interface MenuListener

sectionsRemoved

public void sectionsRemoved(Menu menu,
                            int index,
                            Sequence<Menu.Section> removed)
Description copied from interface: MenuListener
Called when menu sections have been removed.

Specified by:
sectionsRemoved in interface MenuListener

itemInserted

public void itemInserted(Menu.Section section,
                         int index)
Description copied from interface: MenuListener
Called when a menu item has been inserted.

Specified by:
itemInserted in interface MenuListener

itemsRemoved

public void itemsRemoved(Menu.Section section,
                         int index,
                         Sequence<Menu.Item> removed)
Description copied from interface: MenuListener
Called when menu items have been removed.

Specified by:
itemsRemoved in interface MenuListener