Source code: javax/ide/log/LogPage.java
1 package javax.ide.log;
2
3 import javax.ide.view.View;
4
5 /**
6 * The <code>LogPage</code> interface defines the methods to log and
7 * clear messages from a page. <p>
8 *
9 * Extensions that introduce new page types need to implemente this
10 * interface. A new page is introduced by declaring it in the extension
11 * deployment descriptor (EDD) file. There, the page implementation class
12 * is associated with a unique string identifying the page type.<p>
13 *
14 * When an <code>LogPage</code> implementation is instantiated, the page
15 * type string and a page specific name are used as the components of page
16 * {@link javax.ide.util.ID}.
17 */
18 public abstract class LogPage extends View
19 {
20 /**
21 * Display the specified <CODE>msg</CODE>.
22 *
23 * @param msg the message to display.
24 */
25 public abstract void log( Object msg );
26
27 /**
28 * Clear all currently displayed messages.
29 */
30 public abstract void clearAll();
31
32 /**
33 * Get the title to be displayed in the log window hosting this page.
34 *
35 * @return the title to display in the host's title bar.
36 */
37 public abstract String getLongTitle();
38
39 /**
40 * Get the name to display when this page is tabbed.
41 *
42 * @return the name to display when tabbed.
43 */
44 public abstract String getShortTitle();
45
46 /**
47 * Get the tooltip to display when this page is tabbed.
48 *
49 * @return the tooltip to display when tabbed.
50 */
51 public abstract String getToolTip();
52 }