nextapp.echo2.extras.app.MenuBarPane Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ibis-echo2 Show documentation
Show all versions of ibis-echo2 Show documentation
Echo2 bundled with Echo2_Extras, Echo2_FileTransfer and echopointing and various improvements/bugfixes
/*
* This file is part of the Echo2 Extras Project.
* Copyright (C) 2002-2009 NextApp, Inc.
*
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*/
package nextapp.echo2.extras.app;
import nextapp.echo2.app.Border;
import nextapp.echo2.app.Color;
import nextapp.echo2.app.Component;
import nextapp.echo2.app.FillImage;
import nextapp.echo2.app.Pane;
import nextapp.echo2.app.PaneContainer;
import nextapp.echo2.extras.app.menu.AbstractMenuComponent;
import nextapp.echo2.extras.app.menu.MenuModel;
import nextapp.echo2.extras.app.menu.MenuStateModel;
/**
* A pull-down menu pane. This component should generally be used as a child
* of a vertically-oriented SplitPane component. For a
* "traditional looking" pulldown menu bar with normal-sized fonts, set the
* height of the containing region to between 26 and 32 pixels.
*/
public class MenuBarPane extends AbstractMenuComponent
implements Pane {
public static final String PROPERTY_BACKGROUND_IMAGE = "backgroundImage";
public static final String PROPERTY_BORDER = "border";
public static final String PROPERTY_DISABLED_BACKGROUND = "disabledBackground";
public static final String PROPERTY_DISABLED_BACKGROUND_IMAGE = "disabledBackgroundImage";
public static final String PROPERTY_DISABLED_FOREGROUND = "disabledForeground";
public static final String PROPERTY_MENU_BACKGROUND = "menuBackground";
public static final String PROPERTY_MENU_BACKGROUND_IMAGE = "menuBackgroundImage";
public static final String PROPERTY_MENU_BORDER = "menuBorder";
public static final String PROPERTY_MENU_FOREGROUND = "menuForeground";
public static final String PROPERTY_SELECTION_BACKGROUND = "selectionBackground";
public static final String PROPERTY_SELECTION_BACKGROUND_IMAGE = "selectionBackgroundImage";
public static final String PROPERTY_SELECTION_FOREGROUND = "selectionForeground";
/**
* Creates a new MenuBarPane with an empty
* DefaultMenuModel as its model and a.
* DefaultMenuStateModel to provide state information.
*/
public MenuBarPane() {
this(null, null);
}
/**
* Creates a new MenuBarPane displaying the specified
* MenuModel and using a
* DefaultMenuStateModel to provide state information.
*
* @param model the model
*/
public MenuBarPane(MenuModel model) {
this(model, null);
}
/**
* Creates a new MenuBarPane displaying the specified
* MenuModel and using the specified
* MenuStateModel to provide state information.
*
* @param model the model
* @param stateModel the selection model
*/
public MenuBarPane(MenuModel model, MenuStateModel stateModel) {
super(model, stateModel);
}
/**
* Returns the background image that will be displayed in the
* MenuBarPane. This background image will also be
* used around pull-down menus in the event that a menu
* background image is not specified.
*
* @return the default background image
*/
public FillImage getBackgroundImage() {
return (FillImage) getProperty(PROPERTY_BACKGROUND_IMAGE);
}
/**
* Returns the border that will be displayed around the
* MenuBarPane. This border will also be used around
* pull-down menus in the event that a menu border is not specified.
*
* @return the default border
*/
public Border getBorder() {
return (Border) getProperty(PROPERTY_BORDER);
}
/**
* Returns the background color used to render disabled menu items.
*
* @return the disabled background
*/
public Color getDisabledBackground() {
return (Color) getProperty(PROPERTY_DISABLED_BACKGROUND);
}
/**
* Returns the background image used to render disabled menu items.
*
* @return the disabled background image
*/
public FillImage getDisabledBackgroundImage() {
return (FillImage) getProperty(PROPERTY_DISABLED_BACKGROUND_IMAGE);
}
/**
* Returns the foreground color used to render disabled menu items.
*
* @return the disabled foreground
*/
public Color getDisabledForeground() {
return (Color) getProperty(PROPERTY_DISABLED_FOREGROUND);
}
/**
* Returns the background color that will be displayed in pull-down
* menus. Use this property only if a color different from
* the one used for the menu bar is desired for pull-down menus
* (otherwise use only the "background" property").
*
* @return the menu background
*/
public Color getMenuBackground() {
return (Color) getProperty(PROPERTY_MENU_BACKGROUND);
}
/**
* Returns the background image that will be displayed in pull-down
* menus. Use this property only if an image different from
* the one used for the menu bar is desired for pull-down menus
* (otherwise use only the "backgroundImage" property").
*
* @return the menu background image
*/
public FillImage getMenuBackgroundImage() {
return (FillImage) getProperty(PROPERTY_MENU_BACKGROUND_IMAGE);
}
/**
* Returns the border that will be displayed around pull-down
* menus. Use this property only if a border different from
* the one used for the menu bar is desired for pull-down menus
* (otherwise use only the "border" property").
*
* @return the menu border
*/
public Border getMenuBorder() {
return (Border) getProperty(PROPERTY_MENU_BORDER);
}
/**
* Returns the foreground color that will be displayed in pull-down
* menus. Use this property only if a color different from
* the one used for the menu bar is desired for pull-down menus
* (otherwise use only the "foreground" property").
*
* @return the menu foreground
*/
public Color getMenuForeground() {
return (Color) getProperty(PROPERTY_MENU_FOREGROUND);
}
/**
* Returns the background color used to highlight the currently
* selected menu item.
*
* @return the selection background
*/
public Color getSelectionBackground() {
return (Color) getProperty(PROPERTY_SELECTION_BACKGROUND);
}
/**
* Returns the background image used to highlight the currently
* selected menu item.
*
* @return the selection background image
*/
public FillImage getSelectionBackgroundImage() {
return (FillImage) getProperty(PROPERTY_SELECTION_BACKGROUND_IMAGE);
}
/**
* Returns the foreground color used to highlight the currently
* selected menu item.
*
* @return the selection foreground
*/
public Color getSelectionForeground() {
return (Color) getProperty(PROPERTY_SELECTION_FOREGROUND);
}
/**
* @see nextapp.echo2.app.Component#isValidParent(nextapp.echo2.app.Component)
*/
public boolean isValidParent(Component c) {
if (!super.isValidParent(c)) {
return false;
}
// Ensure parent is a PaneContainer.
return c instanceof PaneContainer;
}
/**
* Sets the background image that will be displayed in the
* MenuBarPane. This background image will also be
* used around pull-down menus in the event that a menu
* background image is not specified.
*
* @param newValue the new default background image
*/
public void setBackgroundImage(FillImage newValue) {
setProperty(PROPERTY_BACKGROUND_IMAGE, newValue);
}
/**
* Sets the border that will be displayed around the
* MenuBarPane. This border will also be used around
* pull-down menus in the event that a menu border is not specified.
*
* @param newValue the new default border
*/
public void setBorder(Border newValue) {
setProperty(PROPERTY_BORDER, newValue);
}
/**
* Sets the background color used to render disabled menu items.
*
* @param newValue the new disabled background
*/
public void setDisabledBackground(Color newValue) {
setProperty(PROPERTY_DISABLED_BACKGROUND, newValue);
}
/**
* Sets the background image used to render disabled menu items.
*
* @param newValue the new disabled background image
*/
public void setDisabledBackgroundImage(FillImage newValue) {
setProperty(PROPERTY_DISABLED_BACKGROUND_IMAGE, newValue);
}
/**
* Sets the foreground color used to render disabled menu items.
*
* @param newValue the new disabled foreground
*/
public void setDisabledForeground(Color newValue) {
setProperty(PROPERTY_DISABLED_FOREGROUND, newValue);
}
/**
* Sets the background color that will be displayed in pull-down
* menus. Use this property only if a color different from
* the one used for the menu bar is desired for pull-down menus
* (otherwise use only the "background" property").
*
* @param newValue the new menu background
*/
public void setMenuBackground(Color newValue) {
setProperty(PROPERTY_MENU_BACKGROUND, newValue);
}
/**
* Sets the background image that will be displayed in pull-down
* menus. Use this property only if an image different from
* the one used for the menu bar is desired for pull-down menus
* (otherwise use only the "backgroundImage" property").
*
* @param newValue the new menu background image
*/
public void setMenuBackgroundImage(FillImage newValue) {
setProperty(PROPERTY_MENU_BACKGROUND_IMAGE, newValue);
}
/**
* Sets the border that will be displayed around pull-down
* menus. Use this property only if a border different from
* the one used for the menu bar is desired for pull-down menus
* (otherwise use only the "border" property").
*
* @param newValue the new menu border
*/
public void setMenuBorder(Border newValue) {
setProperty(PROPERTY_MENU_BORDER, newValue);
}
/**
* Sets the foreground color that will be displayed in pull-down
* menus. Use this property only if a color different from
* the one used for the menu bar is desired for pull-down menus
* (otherwise use only the "foreground" property").
*
* @param newValue the new menu foreground
*/
public void setMenuForeground(Color newValue) {
setProperty(PROPERTY_MENU_FOREGROUND, newValue);
}
/**
* Sets the background color used to highlight the currently
* selected menu item.
*
* @param newValue the new selection background
*/
public void setSelectionBackground(Color newValue) {
setProperty(PROPERTY_SELECTION_BACKGROUND, newValue);
}
/**
* Sets the background image used to highlight the currently
* selected menu item.
*
* @param newValue the new selection background image
*/
public void setSelectionBackgroundImage(FillImage newValue) {
setProperty(PROPERTY_SELECTION_BACKGROUND_IMAGE, newValue);
}
/**
* Sets the foreground color used to highlight the currently
* selected menu item.
*
* @param newValue the new selection foreground
*/
public void setSelectionForeground(Color newValue) {
setProperty(PROPERTY_SELECTION_FOREGROUND, newValue);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy