001/* 002 * This library is part of OpenCms - 003 * the Open Source Content Management System 004 * 005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com) 006 * 007 * This library is free software; you can redistribute it and/or 008 * modify it under the terms of the GNU Lesser General Public 009 * License as published by the Free Software Foundation; either 010 * version 2.1 of the License, or (at your option) any later version. 011 * 012 * This library is distributed in the hope that it will be useful, 013 * but WITHOUT ANY WARRANTY; without even the implied warranty of 014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 015 * Lesser General Public License for more details. 016 * 017 * For further information about Alkacon Software, please see the 018 * company website: http://www.alkacon.com 019 * 020 * For further information about OpenCms, please see the 021 * project website: http://www.opencms.org 022 * 023 * You should have received a copy of the GNU Lesser General Public 024 * License along with this library; if not, write to the Free Software 025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 026 */ 027 028package org.opencms.gwt.client.ui; 029 030import com.google.gwt.event.dom.client.HasClickHandlers; 031 032/** 033 * Interface for all tool-bar buttons.<p> 034 * 035 * @since 8.0.0 036 */ 037public interface I_CmsToolbarButton extends HasClickHandlers { 038 039 /** 040 * Returns the localized button title. Will show in tool-tip.<p> 041 * 042 * @return the button title 043 */ 044 String getTitle(); 045 046 /** 047 * Returns whether this button is active (pushed, not disabled).<p> 048 * 049 * @return <code>true</code> if the button is active 050 */ 051 boolean isActive(); 052 053 /** 054 * Method executed when the button is activated.<p> 055 */ 056 void onToolbarActivate(); 057 058 /** 059 * Executed when the tool-bar button is clicked.<p> 060 */ 061 void onToolbarClick(); 062 063 /** 064 * Method executed when the button is deactivated.<p> 065 */ 066 void onToolbarDeactivate(); 067 068 /** 069 * Sets the button to active (pushed, not disabled).<p> 070 * 071 * 072 * @param active <code>true</code> if active 073 */ 074 void setActive(boolean active); 075 076 /** 077 * Enables or disables the button.<p> 078 * 079 * @param enabled if true, enable the button, else disable it 080 */ 081 void setEnabled(boolean enabled); 082}