custombutton.js 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  1. // Copyright 2007 The Closure Library Authors. All Rights Reserved.
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. // http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS-IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. /**
  15. * @fileoverview A button rendered via {@link goog.ui.CustomButtonRenderer}.
  16. *
  17. * @author attila@google.com (Attila Bodis)
  18. */
  19. goog.provide('goog.ui.CustomButton');
  20. goog.require('goog.ui.Button');
  21. goog.require('goog.ui.CustomButtonRenderer');
  22. goog.require('goog.ui.registry');
  23. /**
  24. * A custom button control. Identical to {@link goog.ui.Button}, except it
  25. * defaults its renderer to {@link goog.ui.CustomButtonRenderer}. One could
  26. * just as easily pass {@code goog.ui.CustomButtonRenderer.getInstance()} to
  27. * the {@link goog.ui.Button} constructor and get the same result. Provided
  28. * for convenience.
  29. *
  30. * @param {goog.ui.ControlContent} content Text caption or existing DOM
  31. * structure to display as the button's caption.
  32. * @param {goog.ui.ButtonRenderer=} opt_renderer Optional renderer used to
  33. * render or decorate the button; defaults to
  34. * {@link goog.ui.CustomButtonRenderer}.
  35. * @param {goog.dom.DomHelper=} opt_domHelper Optional DOM helper, used for
  36. * document interaction.
  37. * @constructor
  38. * @extends {goog.ui.Button}
  39. */
  40. goog.ui.CustomButton = function(content, opt_renderer, opt_domHelper) {
  41. goog.ui.Button.call(
  42. this, content, opt_renderer || goog.ui.CustomButtonRenderer.getInstance(),
  43. opt_domHelper);
  44. };
  45. goog.inherits(goog.ui.CustomButton, goog.ui.Button);
  46. // Register a decorator factory function for goog.ui.CustomButtons.
  47. goog.ui.registry.setDecoratorByClassName(
  48. goog.ui.CustomButtonRenderer.CSS_CLASS, function() {
  49. // CustomButton defaults to using CustomButtonRenderer.
  50. return new goog.ui.CustomButton(null);
  51. });