blob: fa425943a87fa44556528ebc771b8f3c0e98d2aa [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.12) on Tue Sep 06 11:23:22 EDT 2022 -->
<title>org.apache.log4j.chainsaw (Apache Chainsaw 2.1.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-09-06">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.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.1.0 API)";
}
}
catch(err) {
}
//-->
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.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" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<main role="main">
<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">
<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">
<th class="colFirst" scope="row"><a href="ChainsawViewer.html" title="interface in org.apache.log4j.chainsaw">ChainsawViewer</a></th>
<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">
<th class="colFirst" scope="row"><a href="EventBatchListener.html" title="interface in org.apache.log4j.chainsaw">EventBatchListener</a></th>
<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">
<th class="colFirst" scope="row"><a href="EventContainer.html" title="interface in org.apache.log4j.chainsaw">EventContainer</a></th>
<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">
<th class="colFirst" scope="row"><a href="EventCountListener.html" title="interface in org.apache.log4j.chainsaw">EventCountListener</a></th>
<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">
<th class="colFirst" scope="row"><a href="LoggerNameListener.html" title="interface in org.apache.log4j.chainsaw">LoggerNameListener</a></th>
<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">
<th class="colFirst" scope="row"><a href="LoggerNameModel.html" title="interface in org.apache.log4j.chainsaw">LoggerNameModel</a></th>
<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">
<th class="colFirst" scope="row"><a href="NewKeyListener.html" title="interface in org.apache.log4j.chainsaw">NewKeyListener</a></th>
<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">
<th class="colFirst" scope="row"><a href="ShutdownListener.html" title="interface in org.apache.log4j.chainsaw">ShutdownListener</a></th>
<td class="colLast">
<div class="block">Chainsaw notifies these Listeners when the user has requested
it to shutdown.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SortTableModel.html" title="interface in org.apache.log4j.chainsaw">SortTableModel</a></th>
<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">
<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">
<th class="colFirst" scope="row"><a href="AbstractPreferencePanel.html" title="class in org.apache.log4j.chainsaw">AbstractPreferencePanel</a></th>
<td class="colLast">
<div class="block">Some basic plumbing for Preference related dialogs.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ApplicationPreferenceModel.html" title="class in org.apache.log4j.chainsaw">ApplicationPreferenceModel</a></th>
<td class="colLast">
<div class="block">Encapsulates the Chainsaw Application wide properties</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ApplicationPreferenceModelPanel.html" title="class in org.apache.log4j.chainsaw">ApplicationPreferenceModelPanel</a></th>
<td class="colLast">
<div class="block">A panel used by the user to modify any application-wide preferences.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ApplicationPreferenceModelSaver.html" title="class in org.apache.log4j.chainsaw">ApplicationPreferenceModelSaver</a></th>
<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">
<th class="colFirst" scope="row"><a href="BasicPrefPanel.html" title="class in org.apache.log4j.chainsaw">BasicPrefPanel</a></th>
<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">
<th class="colFirst" scope="row"><a href="ChainsawAppender.html" title="class in org.apache.log4j.chainsaw">ChainsawAppender</a></th>
<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">
<th class="colFirst" scope="row"><a href="ChainsawAppenderHandler.html" title="class in org.apache.log4j.chainsaw">ChainsawAppenderHandler</a></th>
<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">
<th class="colFirst" scope="row"><a href="ChainsawColumns.html" title="class in org.apache.log4j.chainsaw">ChainsawColumns</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ChainsawConstants.html" title="class in org.apache.log4j.chainsaw">ChainsawConstants</a></th>
<td class="colLast">
<div class="block">Constants used throught Chainsaw.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ChainsawStatusBar.html" title="class in org.apache.log4j.chainsaw">ChainsawStatusBar</a></th>
<td class="colLast">
<div class="block">A general purpose status bar for all Frame windows</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="CheckListCellRenderer.html" title="class in org.apache.log4j.chainsaw">CheckListCellRenderer</a></th>
<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">
<th class="colFirst" scope="row"><a href="ColumnComparator.html" title="class in org.apache.log4j.chainsaw">ColumnComparator</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="CopyEventsToClipboardAction.html" title="class in org.apache.log4j.chainsaw">CopyEventsToClipboardAction</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="CyclicBufferList.html" title="class in org.apache.log4j.chainsaw">CyclicBufferList</a></th>
<td class="colLast">
<div class="block">CyclicBuffer implementation that is Object generic, and implements the List interface.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DockablePanel.html" title="class in org.apache.log4j.chainsaw">DockablePanel</a></th>
<td class="colLast">
<div class="block">Extends the functionality of a JPanel by providing a 'docked' state.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ExpressionRuleContext.html" title="class in org.apache.log4j.chainsaw">ExpressionRuleContext</a></th>
<td class="colLast">
<div class="block">A popup menu which assists in building expression rules.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Generator.html" title="class in org.apache.log4j.chainsaw">Generator</a></th>
<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">
<th class="colFirst" scope="row"><a href="GeneratorBeanInfo.html" title="class in org.apache.log4j.chainsaw">GeneratorBeanInfo</a></th>
<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">
<th class="colFirst" scope="row"><a href="JSortTable.html" title="class in org.apache.log4j.chainsaw">JSortTable</a></th>
<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">
<th class="colFirst" scope="row"><a href="JTextComponentFormatter.html" title="class in org.apache.log4j.chainsaw">JTextComponentFormatter</a></th>
<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">
<th class="colFirst" scope="row"><a href="LogFilePatternLayoutBuilder.html" title="class in org.apache.log4j.chainsaw">LogFilePatternLayoutBuilder</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="LoggerNameModelSupport.html" title="class in org.apache.log4j.chainsaw">LoggerNameModelSupport</a></th>
<td class="colLast">
<div class="block">An implementation of LoggerNameModel which can be used as a delegate</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="LoggerNameTree.html" title="class in org.apache.log4j.chainsaw">LoggerNameTree</a></th>
<td class="colLast">
<div class="block">LoggerNameTree is used to display a TreeModel of LoggerNames.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="LoggingEventWrapper.html" title="class in org.apache.log4j.chainsaw">LoggingEventWrapper</a></th>
<td class="colLast">
<div class="block">Wrap access to a LoggingEvent.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="LogPanel.html" title="class in org.apache.log4j.chainsaw">LogPanel</a></th>
<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">
<th class="colFirst" scope="row"><a href="LogPanelPreferenceModel.html" title="class in org.apache.log4j.chainsaw">LogPanelPreferenceModel</a></th>
<td class="colLast">
<div class="block">Used to encapsulate all the preferences for a given LogPanel</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="LogPanelPreferencePanel.html" title="class in org.apache.log4j.chainsaw">LogPanelPreferencePanel</a></th>
<td class="colLast">
<div class="block">GUI panel used to manipulate the PreferenceModel for a Log Panel</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="LogUI.html" title="class in org.apache.log4j.chainsaw">LogUI</a></th>
<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="altColor">
<th class="colFirst" scope="row"><a href="ModifiableListModel.html" title="class in org.apache.log4j.chainsaw">ModifiableListModel</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="NewKeyEvent.html" title="class in org.apache.log4j.chainsaw">NewKeyEvent</a></th>
<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="altColor">
<th class="colFirst" scope="row"><a href="PopupListener.html" title="class in org.apache.log4j.chainsaw">PopupListener</a></th>
<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="rowColor">
<th class="colFirst" scope="row"><a href="ProgressPanel.html" title="class in org.apache.log4j.chainsaw">ProgressPanel</a></th>
<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="altColor">
<th class="colFirst" scope="row"><a href="RuleMediator.html" title="class in org.apache.log4j.chainsaw">RuleMediator</a></th>
<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="rowColor">
<th class="colFirst" scope="row"><a href="SavableTabSetting.html" title="class in org.apache.log4j.chainsaw">SavableTabSetting</a></th>
<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="altColor">
<th class="colFirst" scope="row"><a href="SmallButton.html" title="class in org.apache.log4j.chainsaw">SmallButton</a></th>
<td class="colLast">
<div class="block">A better button class that has nice roll over effects.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SortArrowIcon.html" title="class in org.apache.log4j.chainsaw">SortArrowIcon</a></th>
<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="altColor">
<th class="colFirst" scope="row"><a href="SortHeaderRenderer.html" title="class in org.apache.log4j.chainsaw">SortHeaderRenderer</a></th>
<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="rowColor">
<th class="colFirst" scope="row"><a href="TableColorizingRenderer.html" title="class in org.apache.log4j.chainsaw">TableColorizingRenderer</a></th>
<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="altColor">
<th class="colFirst" scope="row"><a href="WelcomePanel.html" title="class in org.apache.log4j.chainsaw">WelcomePanel</a></th>
<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>
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.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" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small><p align="center">Copyright &#169; 2002-2020 <a href="https://www.apache.org/">The 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>
</footer>
</body>
</html>