Files
openlayers/lib/OpenLayers/Control/Button.js
crschmidt 95c178adf2 A brilliant patch adding better documentation to all of our controls from an
unnamed contributor on OpenLayers trac. (Closes #1751)  


git-svn-id: http://svn.openlayers.org/trunk/openlayers@8942 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
2009-03-03 06:30:15 +00:00

44 lines
1.1 KiB
JavaScript

/* Copyright (c) 2006-2007 MetaCarta, Inc., published under a modified BSD license.
* See http://svn.openlayers.org/trunk/openlayers/repository-license.txt
* for the full text of the license. */
/**
* @requires OpenLayers/Control.js
*/
/**
* Class: OpenLayers.Control.Button
* The Button control is a very simple push-button, for use with
* <OpenLayers.Control.Panel>.
* When clicked, the function trigger() is executed.
*
* Inherits from:
* - <OpenLayers.Control>
*
* Use:
* (code)
* var button = new OpenLayers.Control.Button({
* displayClass: "MyButton", trigger: myFunction
* });
* panel.addControls([button]);
* (end)
*
* Will create a button with CSS class MyButtonItemInactive, that
* will call the function MyFunction() when clicked.
*/
OpenLayers.Control.Button = OpenLayers.Class(OpenLayers.Control, {
/**
* Property: type
* {Integer} OpenLayers.Control.TYPE_BUTTON.
*/
type: OpenLayers.Control.TYPE_BUTTON,
/**
* Method: trigger
* Called by a control panel when the button is clicked.
*/
trigger: function() {},
CLASS_NAME: "OpenLayers.Control.Button"
});