NavigationMenu (ontimize-core 5.6.0 API)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JPanel
      - com.ontimize.gui.field.NavigationMenu

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

Direct Known Subclasses:

NavigatorMenuGUI
```
public class NavigationMenu
extends JPanel
```
See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`NavigationMenu.BasicMenuHeaderRenderer` Class that determines a MenuItem renderer by default.
`static class`	`NavigationMenu.DefaultMenuHeaderRenderer` Class that determines a MenuHeader renderer by default.
`static class`	`NavigationMenu.DefaultMenuItemRenderer` Class that determines a MenuItem renderer by default.
`static class`	`NavigationMenu.MenuGroup` Class that contains each Menu displayed into the NavigationMenu.
`static interface`	`NavigationMenu.MenuHeaderRenderer` Interface MenuHeaderRenderer.
`static class`	`NavigationMenu.MenuItem` Class that contains each Item displayed into the MenuGroup of the NavigationMenu.
`static interface`	`NavigationMenu.MenuItemRenderer` Interface MenuItemRenderer.

Nested classes/interfaces inherited from class javax.swing.JPanel
JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`BASICRENDERER`
`protected static String`	`BGBODY` Identification of the "bgbody" XML tag.
`protected static String`	`BGHEADER` Identification of the "bgheader" XML tag.
`protected Image`	`bgImage` Background image of the NavigationMenu.
`static String`	`BLACK`
`static String`	`BLUE`
`protected static String`	`BORDER` Identification of the "border" XML tag.
`protected static String`	`BORDERCLASS` Identification of the "borderclass" XML tag.
`protected static String`	`BORDERCOLOR` Identification of the "bordercolor" XML tag.
`protected boolean`	`centerImage` Parameter that indicates if it is wanted to center the background image into the NavigationMenu.
`protected static String`	`CENTERIMAGE`
`static String`	`CYAN`
`static String`	`DARKBLUE`
`static String`	`DARKGRAY`
`protected static String`	`DRAGALLMENU` Identification of the "dragallmenu" XML tag.
`protected static String`	`DRAGENABLE` Identification of the "dragenable" XML tag.
`static String`	`EAST` Compass-direction east (right).
`protected static String`	`ERROR_MESSAGE` Message error.
`protected Image`	`fixImage` Background image if it is wanted to fit into the NavigationMenu.
`protected int`	`fixImagePosition` Position to place fixImage.
`protected static String`	`FIXIMG`
`protected static String`	`FIXIMGPOSITION`
`protected static String`	`FOREGROUND` Identification of the "fg" XML tag.
`protected static String`	`FOREGROUNDHEADER` Identification of the "fgheader" XML tag.
`static String`	`GRAY`
`static String`	`GREEN`
`protected static String`	`HEADER` Identification of the "header" XML tag.
`protected static String`	`HEADERHEIGHT` Identification of the "headerheight" XML tag.
`protected int`	`height` Height of the NavigationMenu background image.
`protected static String`	`HEIGHT` Identification of the "height" XML tag.
`protected static String`	`ICONS` Identification of the "icons" XML tag.
`protected String`	`imageBasePath` String that contains the base search route of all the images and icons of the NavigationMenu.
`protected static String`	`IMAGEBASEPATH`
`protected static String`	`IMG`
`static String`	`LIGHTGRAY`
`static String`	`MAGENTA`
`protected static String`	`MENU_GROUP_HEADER_ICON`
`protected static String`	`MENUGROUP` Identification of the "MenuGroup" XML tag.
`protected static String`	`MENUGROUPCLASS`
`protected NavigationMenu.MenuHeaderRenderer`	`menuHeaderRenderer` Renderer of the Header.
`protected static String`	`MENUITEMCLASS` Identification of the "menuitemclass" XML tag.
`protected NavigationMenu.MenuItemRenderer`	`menuItemRenderer` Renderer of the MenuItem.
`protected ArrayList`	`menuList` ArrayList that contains all the menuGroups contained into the NavigatioMenu.
`protected boolean`	`mosaic`
`protected static String`	`MOSAIC`
`static String`	`NORTH` Compass-direction North (up).
`static String`	`NORTH_EAST` Compass-direction north-east (upper right).
`static String`	`NORTH_WEST` Compass-direction north west (upper left).
`protected static String`	`OPAQUE` Identification of the "opaque" XML tag.
`protected static String`	`OPTIONS` Identification of the "options" XML tag.
`static String`	`ORANGE`
`protected static Class[]`	`params`
`static String`	`PINK`
`static String`	`RED`
`protected static String`	`ROOT_XML` Identification of the "NavigationMenu" XML tag.
`protected static String`	`SEPARATOR` Identification of the "separator" XML tag.
`static String`	`SOUTH` Compass-direction south (down).
`static String`	`SOUTH_EAST` Compass-direction south-east (lower right).
`static String`	`SOUTH_WEST` Compass-direction south-west (lower left).
`protected static boolean`	`useBasicRenderer` Parameter that indicates if basic renderer is used.
`static String`	`WEST` Compass-direction west (left).
`static String`	`WHITE`
`protected int`	`width` Width of the NavigationMenu background image.
`protected static String`	`WIDTH` Identification of the "width" XML tag.
`protected static String`	`X` Identification of the "x" XML tag.
`protected static String`	`Y` Identification of the "y" XML tag.
`static String`	`YELLOW`

Fields inherited from class javax.swing.JComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, PROPERTIES, SOMEBITS

Constructor Summary

Constructors
Constructor and Description
`NavigationMenu()` Default constructor.
`NavigationMenu(Image bgImage, Image imageLogo, int width, int height)` Constructs a new NavigationMenu specifying the background image, the logo image and its dimensions.
`NavigationMenu(Image bgImage, int width, int height)` Constructs a new NavigationMenu specifying the background image and its dimensions.
`NavigationMenu(URL xml)` Constructs a new NavigationMenu.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`add(NavigationMenu.MenuGroup mg)` This method adds the specified MenuGroup to the NavigationMenu.
`static Color`	`colorRGBHexToColor(String rgb)` This method converts the specified RGBColor into a Color object.
`static Color`	`colorRGBToColor(String rgb)` This method converts the specified RGBColor into a Color object.
`protected NavigationMenu.MenuGroup`	`createMenuGroup(Node node)` This method analyzes a "MenuGroup" node of the XML Document configuration to obtain all the parameter to build a new MenuGroup into the NavigationMenu.
`protected NavigationMenu.MenuGroup`	`createMenuGroupInstance(String header, String[] opts, ImageIcon[] icons, int x, int y, int width, int height, Color bgHeader, Color bgBody, Color fg, Color border)` This method instantiates a new MenuGroup object with the specified parameters.
`Component`	`getComponent(int n)`
`Component[]`	`getComponents()`
`protected Node`	`getNode(NamedNodeMap attributes, String name)`
`Dimension`	`getPreferredSize()` This method obtains the preferred size of the background image of the NavigationMenu.
`boolean`	`isCenterImage()` This method returns if it is wanted to center the background image.
`boolean`	`isTag(Node node)` This method checks if the given node is an Element node of a DOM document or not.
`protected void`	`paintComponent(Graphics g)` This method paints the NavigationMenu
`protected void`	`paintFixImageToPosition(Graphics g)`
`protected void`	`parse(URL xml)` This method parses the XML Document configuration to obtain all the parameters.
`static Color`	`parseColor(String color)` This method analyzes a String that specifies a color and returns a Color object.
`void`	`setCenterImage(boolean centerImage)` This method establishes that the background image have to be centered into the NavigationMenu.
`void`	`setMenuHeaderRenderer(NavigationMenu.MenuHeaderRenderer menuHeaderRenderer)` Establishes the MenuHeader renderer.
`void`	`setMenuItemRenderer(NavigationMenu.MenuItemRenderer menuItemRenderer)` Establishes the MenuItem renderer.
`void`	`setResourceBundle(ResourceBundle bundle)` This method establishes the ResourceBundle of the NavigationMenu to all MenuGroups.

Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponentAt, getComponentAt, getComponentCount, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - IMAGEBASEPATH
```
protected static final String IMAGEBASEPATH
```
    See Also:
    Constant Field Values
  - CENTERIMAGE
```
protected static final String CENTERIMAGE
```
    See Also:
    Constant Field Values
  - IMG
```
protected static final String IMG
```
    See Also:
    Constant Field Values
  - FIXIMG
```
protected static final String FIXIMG
```
    See Also:
    Constant Field Values
  - FIXIMGPOSITION
```
protected static final String FIXIMGPOSITION
```
    See Also:
    Constant Field Values
  - MOSAIC
```
protected static final String MOSAIC
```
    See Also:
    Constant Field Values
  - BASICRENDERER
```
protected static final String BASICRENDERER
```
    See Also:
    Constant Field Values
  - NORTH
```
public static final String NORTH
```
    Compass-direction North (up).
    
    See Also:
    Constant Field Values
  - NORTH_EAST
```
public static final String NORTH_EAST
```
    Compass-direction north-east (upper right).
    
    See Also:
    Constant Field Values
  - EAST
```
public static final String EAST
```
    Compass-direction east (right).
    
    See Also:
    Constant Field Values
  - SOUTH_EAST
```
public static final String SOUTH_EAST
```
    Compass-direction south-east (lower right).
    
    See Also:
    Constant Field Values
  - SOUTH
```
public static final String SOUTH
```
    Compass-direction south (down).
    
    See Also:
    Constant Field Values
  - SOUTH_WEST
```
public static final String SOUTH_WEST
```
    Compass-direction south-west (lower left).
    
    See Also:
    Constant Field Values
  - WEST
```
public static final String WEST
```
    Compass-direction west (left).
    
    See Also:
    Constant Field Values
  - NORTH_WEST
```
public static final String NORTH_WEST
```
    Compass-direction north west (upper left).
    
    See Also:
    Constant Field Values
  - ROOT_XML
```
protected static final String ROOT_XML
```
    Identification of the "NavigationMenu" XML tag.
    
    See Also:
    Constant Field Values
  - MENUGROUP
```
protected static final String MENUGROUP
```
    Identification of the "MenuGroup" XML tag.
    
    See Also:
    Constant Field Values
  - HEADER
```
protected static final String HEADER
```
    Identification of the "header" XML tag.
    
    See Also:
    Constant Field Values
  - OPTIONS
```
protected static final String OPTIONS
```
    Identification of the "options" XML tag.
    
    See Also:
    Constant Field Values
  - ICONS
```
protected static final String ICONS
```
    Identification of the "icons" XML tag.
    
    See Also:
    Constant Field Values
  - X
```
protected static final String X
```
    Identification of the "x" XML tag.
    
    See Also:
    Constant Field Values
  - Y
```
protected static final String Y
```
    Identification of the "y" XML tag.
    
    See Also:
    Constant Field Values
  - WIDTH
```
protected static final String WIDTH
```
    Identification of the "width" XML tag.
    
    See Also:
    Constant Field Values
  - HEIGHT
```
protected static final String HEIGHT
```
    Identification of the "height" XML tag.
    
    See Also:
    Constant Field Values
  - BGHEADER
```
protected static final String BGHEADER
```
    Identification of the "bgheader" XML tag.
    
    See Also:
    Constant Field Values
  - BGBODY
```
protected static final String BGBODY
```
    Identification of the "bgbody" XML tag.
    
    See Also:
    Constant Field Values
  - FOREGROUND
```
protected static final String FOREGROUND
```
    Identification of the "fg" XML tag.
    
    See Also:
    Constant Field Values
  - FOREGROUNDHEADER
```
protected static final String FOREGROUNDHEADER
```
    Identification of the "fgheader" XML tag.
    
    See Also:
    Constant Field Values
  - BORDERCOLOR
```
protected static final String BORDERCOLOR
```
    Identification of the "bordercolor" XML tag.
    
    See Also:
    Constant Field Values
  - MENUITEMCLASS
```
protected static final String MENUITEMCLASS
```
    Identification of the "menuitemclass" XML tag.
    
    See Also:
    Constant Field Values
  - HEADERHEIGHT
```
protected static final String HEADERHEIGHT
```
    Identification of the "headerheight" XML tag.
    
    See Also:
    Constant Field Values
  - BORDERCLASS
```
protected static final String BORDERCLASS
```
    Identification of the "borderclass" XML tag.
    
    See Also:
    Constant Field Values
  - OPAQUE
```
protected static final String OPAQUE
```
    Identification of the "opaque" XML tag.
    
    See Also:
    Constant Field Values
  - DRAGENABLE
```
protected static final String DRAGENABLE
```
    Identification of the "dragenable" XML tag.
    
    See Also:
    Constant Field Values
  - DRAGALLMENU
```
protected static final String DRAGALLMENU
```
    Identification of the "dragallmenu" XML tag.
    
    See Also:
    Constant Field Values
  - SEPARATOR
```
protected static final String SEPARATOR
```
    Identification of the "separator" XML tag.
    
    See Also:
    Constant Field Values
  - BORDER
```
protected static final String BORDER
```
    Identification of the "border" XML tag.
    
    See Also:
    Constant Field Values
  - MENU_GROUP_HEADER_ICON
```
protected static final String MENU_GROUP_HEADER_ICON
```
    See Also:
    Constant Field Values
  - MENUGROUPCLASS
```
protected static final String MENUGROUPCLASS
```
    See Also:
    Constant Field Values
  - params
```
protected static final Class[] params
```
  - ERROR_MESSAGE
```
protected static final String ERROR_MESSAGE
```
    Message error.
    
    See Also:
    Constant Field Values
  - GRAY
```
public static final String GRAY
```
    See Also:
    Constant Field Values
  - BLACK
```
public static final String BLACK
```
    See Also:
    Constant Field Values
  - BLUE
```
public static final String BLUE
```
    See Also:
    Constant Field Values
  - RED
```
public static final String RED
```
    See Also:
    Constant Field Values
  - YELLOW
```
public static final String YELLOW
```
    See Also:
    Constant Field Values
  - CYAN
```
public static final String CYAN
```
    See Also:
    Constant Field Values
  - DARKGRAY
```
public static final String DARKGRAY
```
    See Also:
    Constant Field Values
  - GREEN
```
public static final String GREEN
```
    See Also:
    Constant Field Values
  - LIGHTGRAY
```
public static final String LIGHTGRAY
```
    See Also:
    Constant Field Values
  - MAGENTA
```
public static final String MAGENTA
```
    See Also:
    Constant Field Values
  - ORANGE
```
public static final String ORANGE
```
    See Also:
    Constant Field Values
  - PINK
```
public static final String PINK
```
    See Also:
    Constant Field Values
  - WHITE
```
public static final String WHITE
```
    See Also:
    Constant Field Values
  - DARKBLUE
```
public static final String DARKBLUE
```
    See Also:
    Constant Field Values
  - menuList
```
protected ArrayList menuList
```
    ArrayList that contains all the menuGroups contained into the NavigatioMenu.
  - bgImage
```
protected Image bgImage
```
    Background image of the NavigationMenu.
  - fixImage
```
protected Image fixImage
```
    Background image if it is wanted to fit into the NavigationMenu. It could be used as a centered corporative logo.
  - fixImagePosition
```
protected int fixImagePosition
```
    Position to place fixImage. It could be: north, south, east, west, north_east, south_east, north_west, south_west.
  - centerImage
```
protected boolean centerImage
```
    Parameter that indicates if it is wanted to center the background image into the NavigationMenu.
  - mosaic
```
protected boolean mosaic
```
  - imageBasePath
```
protected String imageBasePath
```
    String that contains the base search route of all the images and icons of the NavigationMenu.
  - width
```
protected int width
```
    Width of the NavigationMenu background image.
  - height
```
protected int height
```
    Height of the NavigationMenu background image.
  - useBasicRenderer
```
protected static boolean useBasicRenderer
```
    Parameter that indicates if basic renderer is used.
  - menuItemRenderer
```
protected NavigationMenu.MenuItemRenderer menuItemRenderer
```
    Renderer of the MenuItem.
  - menuHeaderRenderer
```
protected NavigationMenu.MenuHeaderRenderer menuHeaderRenderer
```
    Renderer of the Header.
- Constructor Detail
  - NavigationMenu
```
public NavigationMenu(Image bgImage,
              int width,
              int height)
```
    Constructs a new NavigationMenu specifying the background image and its dimensions.
    
    Parameters:
    bgImage - The background image of the NavigationMenu.
    width - The width of the image.
    height - The height of the image.
  - NavigationMenu
```
public NavigationMenu(Image bgImage,
              Image imageLogo,
              int width,
              int height)
```
    Constructs a new NavigationMenu specifying the background image, the logo image and its dimensions.
    
    Parameters:
    bgImage - The background image of the NavigationMenu.
    imageLogo - The logo image of the NavigationMenu.
    width - The width of the image.
    height - The height of the image.
  - NavigationMenu
```
public NavigationMenu()
               throws Exception
```
    Default constructor. It sets null layout to the NavigationMenu.
    
    Throws:
    
    Exception
  - NavigationMenu
```
public NavigationMenu(URL xml)
               throws Exception
```
    Constructs a new NavigationMenu. The characteristics and parameters are read from an XML Document.
    
    Parameters:
    xml - The XML Document that contains the configuration parameters.
    
    Throws:
    
    Exception
- Method Detail
  - setMenuItemRenderer
```
public void setMenuItemRenderer(NavigationMenu.MenuItemRenderer menuItemRenderer)
```
    Establishes the MenuItem renderer.
    
    Parameters:
    menuItemRenderer - The MenuItem renderer.
  - setMenuHeaderRenderer
```
public void setMenuHeaderRenderer(NavigationMenu.MenuHeaderRenderer menuHeaderRenderer)
```
    Establishes the MenuHeader renderer.
    
    Parameters:
    menuHeaderRenderer - The MenuHeader renderer.
  - getPreferredSize
```
public Dimension getPreferredSize()
```
    This method obtains the preferred size of the background image of the NavigationMenu.
    
    Overrides:
    
    getPreferredSize in class JComponent
    
    Returns:
    a Dimension object with the background image dimensions.
  - getComponent
```
public Component getComponent(int n)
```
    Overrides:
    
    getComponent in class Container
  - getComponents
```
public Component[] getComponents()
```
    Overrides:
    
    getComponents in class Container
  - add
```
public void add(NavigationMenu.MenuGroup mg)
```
    This method adds the specified MenuGroup to the NavigationMenu.
    
    Parameters:
    mg - The MenuGroup object to be added.
  - setResourceBundle
```
public void setResourceBundle(ResourceBundle bundle)
```
    This method establishes the ResourceBundle of the NavigationMenu to all MenuGroups.
    
    Parameters:
    bundle - The ResourceBundle.
  - paintComponent
```
protected void paintComponent(Graphics g)
```
    This method paints the NavigationMenu
    
    Overrides:
    
    paintComponent in class JComponent
    
    Parameters:
    g - The graphics.
  - paintFixImageToPosition
```
protected void paintFixImageToPosition(Graphics g)
```
  - parse
```
protected void parse(URL xml)
              throws Exception
```
    This method parses the XML Document configuration to obtain all the parameters.
    
    Parameters:
    xml - The XML Document configuration.
    
    Throws:
    
    Exception
  - isTag
```
public boolean isTag(Node node)
```
    This method checks if the given node is an Element node of a DOM document or not.
    
    Parameters:
    node - The node to be checked.
    
    Returns:
    a boolean.
  - getNode
```
protected Node getNode(NamedNodeMap attributes,
           String name)
```
  - createMenuGroup
```
protected NavigationMenu.MenuGroup createMenuGroup(Node node)
                                            throws Exception
```
    This method analyzes a "MenuGroup" node of the XML Document configuration to obtain all the parameter to build a new MenuGroup into the NavigationMenu.
    
    Parameters:
    node - The "MenuGroup" node of the XML Document configuration.
    
    Returns:
    a MenuGroup object.
    
    Throws:
    
    Exception
  - createMenuGroupInstance
```
protected NavigationMenu.MenuGroup createMenuGroupInstance(String header,
                                               String[] opts,
                                               ImageIcon[] icons,
                                               int x,
                                               int y,
                                               int width,
                                               int height,
                                               Color bgHeader,
                                               Color bgBody,
                                               Color fg,
                                               Color border)
                                                    throws Exception
```
    This method instantiates a new MenuGroup object with the specified parameters.
    
    Parameters:
    header - String with the text to display into the Header of the MenuGroup.
    opts - String Array with the identifier of each MenuItem of the MenuGroup.
    icons - ImageIcon Array with the icons to each MenuItem of the MenuGroup.
    x - The coordinate x of the MenuGroup into the NavigationMenu.
    y - The coordinate y of the MenuGroup into the NavigationMenu.
    width - The width of the MenuGroup.
    height - The absolute height of the MenuGroup. The header height is included into this height.
    bgHeader - The color of the MenuGroup Header.
    bgBody - The color of the background MenuGroup.
    fg - The color of the MenuGroup font.
    border - The color of the border of the MenuGroup.
    
    Returns:
    a MenuGroup object.
    
    Throws:
    
    Exception
  - colorRGBToColor
```
public static Color colorRGBToColor(String rgb)
                             throws Exception
```
    This method converts the specified RGBColor into a Color object.
    
    Parameters:
    rgb - String specifying a RGB color separated by semicolon "R;G;B". That is "102;23;44"
    
    Returns:
    a Color.
    
    Throws:
    
    Exception
  - colorRGBHexToColor
```
public static Color colorRGBHexToColor(String rgb)
                                throws Exception
```
    This method converts the specified RGBColor into a Color object.
    
    Parameters:
    rgb - String specifying a RGB color expressed into Hexadecimal form "#". That is "#ffffff"
    
    Returns:
    a Color.
    
    Throws:
    
    Exception
  - parseColor
```
public static Color parseColor(String color)
                        throws Exception
```
    This method analyzes a String that specifies a color and returns a Color object.
    
    Parameters:
    color - String with the color.
    
    Returns:
    a Color object.
    
    Throws:
    
    Exception
  - isCenterImage
```
public boolean isCenterImage()
```
    This method returns if it is wanted to center the background image. If it is true the background image is centered.
    
    Returns:
    a boolean.
  - setCenterImage
```
public void setCenterImage(boolean centerImage)
```
    This method establishes that the background image have to be centered into the NavigationMenu.
    
    Parameters:
    centerImage -

Class NavigationMenu

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

Nested classes/interfaces inherited from class java.awt.Container

Nested classes/interfaces inherited from class java.awt.Component

Field Summary

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JPanel

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Field Detail

IMAGEBASEPATH

CENTERIMAGE

IMG

FIXIMG

FIXIMGPOSITION

MOSAIC

BASICRENDERER

NORTH

NORTH_EAST

EAST

SOUTH_EAST

SOUTH

SOUTH_WEST

WEST

NORTH_WEST

ROOT_XML

MENUGROUP

HEADER

OPTIONS

ICONS

X

Y

WIDTH

HEIGHT

BGHEADER

BGBODY

FOREGROUND

FOREGROUNDHEADER

BORDERCOLOR

MENUITEMCLASS

HEADERHEIGHT

BORDERCLASS

OPAQUE

DRAGENABLE

DRAGALLMENU

SEPARATOR

BORDER

MENU_GROUP_HEADER_ICON

MENUGROUPCLASS

params

ERROR_MESSAGE

GRAY

BLACK

BLUE

RED

YELLOW

CYAN

DARKGRAY

GREEN

LIGHTGRAY

MAGENTA

ORANGE

PINK

WHITE

DARKBLUE

menuList

bgImage

fixImage

fixImagePosition

centerImage

mosaic

imageBasePath