blob: 207f77b099d9ddfdbf525aef281db7be75cebe75 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_111) on Sat Jan 20 11:27:19 CST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.log4j.chainsaw (Apache Chainsaw 2.0.0 API)</title>
<meta name="date" content="2018-01-20">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.apache.log4j.chainsaw (Apache Chainsaw 2.0.0 API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/log4j/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../org/apache/log4j/chainsaw/color/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/log4j/chainsaw/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.log4j.chainsaw</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/ChainsawViewer.html" title="interface in org.apache.log4j.chainsaw">ChainsawViewer</a></td>
<td class="colLast">
<div class="block">Chainsaw compatible gui viewers must implement this interface
in order to be opened and configured by the ChainsawAppender class.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/EventBatchListener.html" title="interface in org.apache.log4j.chainsaw">EventBatchListener</a></td>
<td class="colLast">
<div class="block">Implementations of this interface like to be notified
of arriving batches of LoggingEvents, but may only
be interested in those coming from a particular source</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/EventContainer.html" title="interface in org.apache.log4j.chainsaw">EventContainer</a></td>
<td class="colLast">
<div class="block">To allow pluggable TableModel implementations for Chainsaw, this interface has been factored out.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/EventCountListener.html" title="interface in org.apache.log4j.chainsaw">EventCountListener</a></td>
<td class="colLast">
<div class="block">Listeners can be notified when the # of events in a particular model
changes</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/LoggerNameListener.html" title="interface in org.apache.log4j.chainsaw">LoggerNameListener</a></td>
<td class="colLast">
<div class="block">Implementations are notified when new Logger names
are added to the related LoggerNameModel instance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/LoggerNameModel.html" title="interface in org.apache.log4j.chainsaw">LoggerNameModel</a></td>
<td class="colLast">
<div class="block">Implementations of this model contain all the known Logger
names within it's model space.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/NewKeyListener.html" title="interface in org.apache.log4j.chainsaw">NewKeyListener</a></td>
<td class="colLast">
<div class="block">Interested parties are notified when a MDC/Property key has arrived
that has not been seen before by the source Model</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/ShutdownListener.html" title="interface in org.apache.log4j.chainsaw">ShutdownListener</a></td>
<td class="colLast">
<div class="block">Chainsaw notifies these Listeners when the user has requested
it to shutdown.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/SortTableModel.html" title="interface in org.apache.log4j.chainsaw">SortTableModel</a></td>
<td class="colLast">
<div class="block">An extended TableModel interface that allows Column sorting</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/AbstractPreferencePanel.html" title="class in org.apache.log4j.chainsaw">AbstractPreferencePanel</a></td>
<td class="colLast">
<div class="block">Some basic plumbing for Preference related dialogs.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/ApplicationPreferenceModel.html" title="class in org.apache.log4j.chainsaw">ApplicationPreferenceModel</a></td>
<td class="colLast">
<div class="block">Encapsulates the Chainsaw Application wide properties</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/ApplicationPreferenceModelPanel.html" title="class in org.apache.log4j.chainsaw">ApplicationPreferenceModelPanel</a></td>
<td class="colLast">
<div class="block">A panel used by the user to modify any application-wide preferences.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/ApplicationPreferenceModelSaver.html" title="class in org.apache.log4j.chainsaw">ApplicationPreferenceModelSaver</a></td>
<td class="colLast">
<div class="block">Helper class that helps delegate the work of loading and saving the values
of the ApplicationPreferenceModel, allowing that class to remain a simple
bean.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/BasicPrefPanel.html" title="class in org.apache.log4j.chainsaw">BasicPrefPanel</a></td>
<td class="colLast">
<div class="block">All of the Preferences panels used in this class extend from
this, it is used to provide standard L&amp;F required by all.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/ChainsawAppender.html" title="class in org.apache.log4j.chainsaw">ChainsawAppender</a></td>
<td class="colLast">
<div class="block">ChainsawAppender receives LoggingEvents from the local
Log4J environment, and appends them into a model that
can be used inside a Swing GUI</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/ChainsawAppenderHandler.html" title="class in org.apache.log4j.chainsaw">ChainsawAppenderHandler</a></td>
<td class="colLast">
<div class="block">A handler class that either extends a particular appender hierarchy or can be
bound into the Log4j appender framework, and queues events, to be later
dispatched to registered/interested parties.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/ChainsawColumns.html" title="class in org.apache.log4j.chainsaw">ChainsawColumns</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/ChainsawConstants.html" title="class in org.apache.log4j.chainsaw">ChainsawConstants</a></td>
<td class="colLast">
<div class="block">Constants used throught Chainsaw.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/ChainsawStatusBar.html" title="class in org.apache.log4j.chainsaw">ChainsawStatusBar</a></td>
<td class="colLast">
<div class="block">A general purpose status bar for all Frame windows</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/CheckListCellRenderer.html" title="class in org.apache.log4j.chainsaw">CheckListCellRenderer</a></td>
<td class="colLast">
<div class="block">A ListCellRenderer that display a check box if the value
has been "checked".</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/ColumnComparator.html" title="class in org.apache.log4j.chainsaw">ColumnComparator</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/CopyEventsToClipboardAction.html" title="class in org.apache.log4j.chainsaw">CopyEventsToClipboardAction</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/CyclicBufferList.html" title="class in org.apache.log4j.chainsaw">CyclicBufferList</a></td>
<td class="colLast">
<div class="block">CyclicBuffer implementation that is Object generic, and implements the List interface.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/DockablePanel.html" title="class in org.apache.log4j.chainsaw">DockablePanel</a></td>
<td class="colLast">
<div class="block">Extends the functionality of a JPanel by providing a 'docked' state.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/ExpressionRuleContext.html" title="class in org.apache.log4j.chainsaw">ExpressionRuleContext</a></td>
<td class="colLast">
<div class="block">A popup menu which assists in building expression rules.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/Generator.html" title="class in org.apache.log4j.chainsaw">Generator</a></td>
<td class="colLast">
<div class="block">Class designed to stress, and/or test the Chainsaw GUI by sending it
lots of Logging Events.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/GeneratorBeanInfo.html" title="class in org.apache.log4j.chainsaw">GeneratorBeanInfo</a></td>
<td class="colLast">
<div class="block">A BeanInfo class to be used as meta-data about the
Generator plugin</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/JSortTable.html" title="class in org.apache.log4j.chainsaw">JSortTable</a></td>
<td class="colLast">
<div class="block">A Sortable JTable implementation that allows a user to click on a
specific Column and have the row information sorted by that column.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/JTextComponentFormatter.html" title="class in org.apache.log4j.chainsaw">JTextComponentFormatter</a></td>
<td class="colLast">
<div class="block">Apply system font and size (normal size + 1) rule if the JEditorPane document contains html.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/LogFilePatternLayoutBuilder.html" title="class in org.apache.log4j.chainsaw">LogFilePatternLayoutBuilder</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/LoggerNameModelSupport.html" title="class in org.apache.log4j.chainsaw">LoggerNameModelSupport</a></td>
<td class="colLast">
<div class="block">An implementation of LoggerNameModel which can be used as a delegate</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/LoggerNameTree.html" title="class in org.apache.log4j.chainsaw">LoggerNameTree</a></td>
<td class="colLast">
<div class="block">LoggerNameTree is used to display a TreeModel of LoggerNames.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/LoggingEventWrapper.html" title="class in org.apache.log4j.chainsaw">LoggingEventWrapper</a></td>
<td class="colLast">
<div class="block">Wrap access to a LoggingEvent.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/LogPanel.html" title="class in org.apache.log4j.chainsaw">LogPanel</a></td>
<td class="colLast">
<div class="block">A LogPanel provides a view to a collection of LoggingEvents.<br>
<br>
As events are received, the keywords in the 'tab identifier' application
preference are replaced with the values from the received event.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/LogPanelPreferenceModel.html" title="class in org.apache.log4j.chainsaw">LogPanelPreferenceModel</a></td>
<td class="colLast">
<div class="block">Used to encapsulate all the preferences for a given LogPanel</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/LogPanelPreferencePanel.html" title="class in org.apache.log4j.chainsaw">LogPanelPreferencePanel</a></td>
<td class="colLast">
<div class="block">GUI panel used to manipulate the PreferenceModel for a Log Panel</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/LogUI.html" title="class in org.apache.log4j.chainsaw">LogUI</a></td>
<td class="colLast">
<div class="block">The main entry point for Chainsaw, this class represents the first frame
that is used to display a Welcome panel, and any other panels that are
generated because Logging Events are streamed via a Receiver, or other
mechanism.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/ModifiableListModel.html" title="class in org.apache.log4j.chainsaw">ModifiableListModel</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/NewKeyEvent.html" title="class in org.apache.log4j.chainsaw">NewKeyEvent</a></td>
<td class="colLast">
<div class="block">An event representing when a Key has arrived inside a Chainsaw model that has
not been seen previously.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/PopupListener.html" title="class in org.apache.log4j.chainsaw">PopupListener</a></td>
<td class="colLast">
<div class="block">Ensures that a specific popupMenu is displayed when the relevant
mouse events are trapped.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/ProgressPanel.html" title="class in org.apache.log4j.chainsaw">ProgressPanel</a></td>
<td class="colLast">
<div class="block">A simple ProgressPanel that can be used, a little more flexible
than ProgressMonitor when you want it to be shown REGARDLESS
of any timeouts etc.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/RuleMediator.html" title="class in org.apache.log4j.chainsaw">RuleMediator</a></td>
<td class="colLast">
<div class="block">A mediator class that implements the Rule interface, by combining several
optional rules used by Chainsaw's filtering GUI's into a single Rule.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/SavableTabSetting.html" title="class in org.apache.log4j.chainsaw">SavableTabSetting</a></td>
<td class="colLast">
<div class="block">This class is used to in saving and loading the tab settings
of Chainsaw....</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/SmallButton.html" title="class in org.apache.log4j.chainsaw">SmallButton</a></td>
<td class="colLast">
<div class="block">A better button class that has nice roll over effects.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/SortArrowIcon.html" title="class in org.apache.log4j.chainsaw">SortArrowIcon</a></td>
<td class="colLast">
<div class="block">An Icon that is a Nice arrow to be used for displaying which
Column is being used for sorting.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/SortHeaderRenderer.html" title="class in org.apache.log4j.chainsaw">SortHeaderRenderer</a></td>
<td class="colLast">
<div class="block">A Table Column header renederer that displays a nice Up/Down arrow
depending on whether this column is the current sort column or not,
and which way the sort is functioning</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/TableColorizingRenderer.html" title="class in org.apache.log4j.chainsaw">TableColorizingRenderer</a></td>
<td class="colLast">
<div class="block">A specific TableCellRenderer that colourizes a particular cell based on
some ColourFilters that have been stored according to the value for the row</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/log4j/chainsaw/WelcomePanel.html" title="class in org.apache.log4j.chainsaw">WelcomePanel</a></td>
<td class="colLast">
<div class="block">An initial Welcome Panel that is used when Chainsaw starts up, can displays
a HTML pages based on URLs.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/log4j/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../org/apache/log4j/chainsaw/color/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/log4j/chainsaw/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><p align="center">Copyright &#169; 2002-2018 <a href="https://www.apache.org">Apache Software Foundation</a>. All Rights Reserved.<br /> Apache Logging, Apache Log4j, Log4j, Apache Chainsaw, Chainsaw, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.</p></small></p>
</body>
</html>