/jEdit/tags/jedit-4-5-pre1/org/gjt/sp/jedit/msg/EditPaneUpdate.java

# · Java · 101 lines · 31 code · 12 blank · 58 comment · 2 complexity · b8a9024ca45c017f1a990ccd4b7b0df4 MD5 · raw file

  1. /*
  2. * EditPaneUpdate.java - Edit pane update message
  3. * Copyright (C) 1999, 2000 Slava Pestov
  4. *
  5. * This program is free software; you can redistribute it and/or
  6. * modify it under the terms of the GNU General Public License
  7. * as published by the Free Software Foundation; either version 2
  8. * of the License, or any later version.
  9. *
  10. * This program is distributed in the hope that it will be useful,
  11. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13. * GNU General Public License for more details.
  14. *
  15. * You should have received a copy of the GNU General Public License
  16. * along with this program; if not, write to the Free Software
  17. * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18. */
  19. package org.gjt.sp.jedit.msg;
  20. import org.gjt.sp.jedit.*;
  21. /**
  22. * Message sent when an edit pane-related change occurs.
  23. * @author Slava Pestov
  24. * @version $Id: EditPaneUpdate.java 14916 2009-04-12 15:49:33Z ezust $
  25. *
  26. * @since jEdit 2.5pre1
  27. */
  28. public class EditPaneUpdate extends EBMessage
  29. {
  30. /**
  31. * Edit pane created.
  32. */
  33. public static final Object CREATED = "CREATED";
  34. /**
  35. * Edit pane destroyed.
  36. */
  37. public static final Object DESTROYED = "DESTROYED";
  38. /**
  39. * The current buffer in the EditPane has changed to show a different buffer. This
  40. * happens when an action results in a call to EditPane.setBuffer().
  41. */
  42. public static final Object BUFFER_CHANGED = "BUFFER_CHANGED";
  43. /**
  44. * Edit pane caret position is about to change in a major way
  45. */
  46. public static final Object POSITION_CHANGING = "POSITION_CHANGING";
  47. /**
  48. * Edit pane buffer is about to change. You should see this before BUFFER_CHANGED.
  49. * @since 4.3pre3
  50. */
  51. public static final Object BUFFER_CHANGING = "BUFFER_CHANGING";
  52. /**
  53. * The bufferSet scope of the EditPane was changed.
  54. * @since 4.3pre15
  55. */
  56. public static final Object BUFFERSET_CHANGED = "BUFFERSET_CHANGED";
  57. /**
  58. * Creates a new edit pane update message.
  59. * @param editPane The edit pane
  60. * @param what What happened
  61. */
  62. public EditPaneUpdate(EditPane editPane, Object what)
  63. {
  64. super(editPane);
  65. if(what == null)
  66. throw new NullPointerException("What must be non-null");
  67. this.what = what;
  68. }
  69. /**
  70. * Returns what caused this edit pane update.
  71. */
  72. public Object getWhat()
  73. {
  74. return what;
  75. }
  76. /**
  77. * Returns the edit pane involved.
  78. */
  79. public EditPane getEditPane()
  80. {
  81. return (EditPane)getSource();
  82. }
  83. public String paramString()
  84. {
  85. return "what=" + what + "," + super.paramString();
  86. }
  87. // private members
  88. private Object what;
  89. }