| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.3"/> |
| <title>Lucene.Net: Lucene.Net.Search.Highlight.SpanGradientFormatter Class Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/search.js"></script> |
| <script type="text/javascript"> |
| $(document).ready(function() { searchBox.OnSelectItem(0); }); |
| </script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectlogo"><img alt="Logo" src="lucene-net-icon-128x128.png"/></td> |
| <td style="padding-left: 0.5em;"> |
| <div id="projectname">Lucene.Net |
|  <span id="projectnumber">3.0.3</span> |
| </div> |
| <div id="projectbrief">Lucene.Net is a .NET port of the Java Lucene Indexing Library</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.3 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <div id="navrow1" class="tabs"> |
| <ul class="tablist"> |
| <li><a href="Index.html"><span>Main Page</span></a></li> |
| <li><a href="namespaces.html"><span>Packages</span></a></li> |
| <li class="current"><a href="annotated.html"><span>Classes</span></a></li> |
| <li><a href="files.html"><span>Files</span></a></li> |
| <li> |
| <div id="MSearchBox" class="MSearchBoxInactive"> |
| <span class="left"> |
| <img id="MSearchSelect" src="search/mag_sel.png" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| alt=""/> |
| <input type="text" id="MSearchField" value="Search" accesskey="S" |
| onfocus="searchBox.OnSearchFieldFocus(true)" |
| onblur="searchBox.OnSearchFieldFocus(false)" |
| onkeyup="searchBox.OnSearchFieldChange(event)"/> |
| </span><span class="right"> |
| <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> |
| </span> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div id="navrow2" class="tabs2"> |
| <ul class="tablist"> |
| <li><a href="annotated.html"><span>Class List</span></a></li> |
| <li><a href="classes.html"><span>Class Index</span></a></li> |
| <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
| <li><a href="functions.html"><span>Class Members</span></a></li> |
| </ul> |
| </div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Properties</a></div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespace_lucene.html">Lucene</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net.html">Net</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_search.html">Search</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_search_1_1_highlight.html">Highlight</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_span_gradient_formatter.html">SpanGradientFormatter</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_span_gradient_formatter-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Search.Highlight.SpanGradientFormatter Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Formats text with different color intensity depending on the score of the term using the span tag. <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_gradient_formatter.html" title="Formats text with different color intensity depending on the score of the term. ">GradientFormatter</a> uses a bgcolor argument to the font tag which doesn't work in Mozilla, thus this class. |
| <a href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_span_gradient_formatter.html#details">More...</a></p> |
| |
| <p>Inherits <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_gradient_formatter.html">Lucene.Net.Search.Highlight.GradientFormatter</a>.</p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:afb465aee42ca6611dbb845f98f328205"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_span_gradient_formatter.html#afb465aee42ca6611dbb845f98f328205">SpanGradientFormatter</a> (float maxScore, String minForegroundColor, String maxForegroundColor, String minBackgroundColor, String maxBackgroundColor)</td></tr> |
| <tr class="separator:afb465aee42ca6611dbb845f98f328205"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae206e2d6a630a7fca11e8e2f55c1649c"><td class="memItemLeft" align="right" valign="top">override String </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_span_gradient_formatter.html#ae206e2d6a630a7fca11e8e2f55c1649c">HighlightTerm</a> (String originalText, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_token_group.html">TokenGroup</a> tokenGroup)</td></tr> |
| <tr class="separator:ae206e2d6a630a7fca11e8e2f55c1649c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_gradient_formatter"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_gradient_formatter')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_gradient_formatter.html">Lucene.Net.Search.Highlight.GradientFormatter</a></td></tr> |
| <tr class="memitem:a8e9cd06fd87043c18141e50f1f65247f inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_gradient_formatter"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_gradient_formatter.html#a8e9cd06fd87043c18141e50f1f65247f">GradientFormatter</a> (float maxScore, string minForegroundColor, string maxForegroundColor, string minBackgroundColor, string maxBackgroundColor)</td></tr> |
| <tr class="memdesc:a8e9cd06fd87043c18141e50f1f65247f inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_gradient_formatter"><td class="mdescLeft"> </td><td class="mdescRight">Sets the color range for the IDF scores <a href="#a8e9cd06fd87043c18141e50f1f65247f"></a><br/></td></tr> |
| <tr class="separator:a8e9cd06fd87043c18141e50f1f65247f inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_gradient_formatter"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8b4f3a8217fab56248ace5ac7fafc442 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_gradient_formatter"><td class="memItemLeft" align="right" valign="top">virtual string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_gradient_formatter.html#a8b4f3a8217fab56248ace5ac7fafc442">HighlightTerm</a> (string originalText, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_token_group.html">TokenGroup</a> tokenGroup)</td></tr> |
| <tr class="separator:a8b4f3a8217fab56248ace5ac7fafc442 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_gradient_formatter"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_formatter"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_formatter')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_formatter.html">Lucene.Net.Search.Highlight.IFormatter</a></td></tr> |
| <tr class="memitem:a3be9a7a66150550600d98b7173865e91 inherit pub_methods_interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_formatter"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_formatter.html#a3be9a7a66150550600d98b7173865e91">HighlightTerm</a> (System.String originalText, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_token_group.html">TokenGroup</a> tokenGroup)</td></tr> |
| <tr class="separator:a3be9a7a66150550600d98b7173865e91 inherit pub_methods_interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_formatter"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a> |
| Additional Inherited Members</h2></td></tr> |
| <tr class="inherit_header pub_static_methods_class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_gradient_formatter"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_gradient_formatter')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_gradient_formatter.html">Lucene.Net.Search.Highlight.GradientFormatter</a></td></tr> |
| <tr class="memitem:afd072131c91ac935019b71dfa24d8240 inherit pub_static_methods_class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_gradient_formatter"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_gradient_formatter.html#afd072131c91ac935019b71dfa24d8240">HexToInt</a> (string hex)</td></tr> |
| <tr class="memdesc:afd072131c91ac935019b71dfa24d8240 inherit pub_static_methods_class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_gradient_formatter"><td class="mdescLeft"> </td><td class="mdescRight">Converts a hex string into an int. Integer.parseInt(hex, 16) assumes the input is nonnegative unless there is a preceding minus sign. This method reads the input as twos complement instead, so if the input is 8 bytes long, it will correctly restore a negative int produced by Integer.toHexString() but not neccesarily one produced by Integer.toString(x,16) since that method will produce a string like '-FF' for negative integer values. <a href="#afd072131c91ac935019b71dfa24d8240"></a><br/></td></tr> |
| <tr class="separator:afd072131c91ac935019b71dfa24d8240 inherit pub_static_methods_class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_gradient_formatter"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pro_attribs_class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_gradient_formatter"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_gradient_formatter')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_gradient_formatter.html">Lucene.Net.Search.Highlight.GradientFormatter</a></td></tr> |
| <tr class="memitem:a1b6873296437ac90756611694b6fadc3 inherit pro_attribs_class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_gradient_formatter"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_gradient_formatter.html#a1b6873296437ac90756611694b6fadc3">highlightForeground</a></td></tr> |
| <tr class="separator:a1b6873296437ac90756611694b6fadc3 inherit pro_attribs_class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_gradient_formatter"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a22614f768067dc477953f15fbb0b2ec3 inherit pro_attribs_class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_gradient_formatter"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_gradient_formatter.html#a22614f768067dc477953f15fbb0b2ec3">highlightBackground</a></td></tr> |
| <tr class="separator:a22614f768067dc477953f15fbb0b2ec3 inherit pro_attribs_class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_gradient_formatter"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Formats text with different color intensity depending on the score of the term using the span tag. <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_gradient_formatter.html" title="Formats text with different color intensity depending on the score of the term. ">GradientFormatter</a> uses a bgcolor argument to the font tag which doesn't work in Mozilla, thus this class. </p> |
| <dl class="section see"><dt>See Also</dt><dd><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_gradient_formatter.html" title="Formats text with different color intensity depending on the score of the term. ">GradientFormatter</a></dd></dl> |
| |
| <p>Definition at line <a class="el" href="_span_gradient_formatter_8cs_source.html#l00029">29</a> of file <a class="el" href="_span_gradient_formatter_8cs_source.html">SpanGradientFormatter.cs</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="afb465aee42ca6611dbb845f98f328205"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Search.Highlight.SpanGradientFormatter.SpanGradientFormatter </td> |
| <td>(</td> |
| <td class="paramtype">float </td> |
| <td class="paramname"><em>maxScore</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">String </td> |
| <td class="paramname"><em>minForegroundColor</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">String </td> |
| <td class="paramname"><em>maxForegroundColor</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">String </td> |
| <td class="paramname"><em>minBackgroundColor</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">String </td> |
| <td class="paramname"><em>maxBackgroundColor</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_span_gradient_formatter_8cs_source.html#l00035">35</a> of file <a class="el" href="_span_gradient_formatter_8cs_source.html">SpanGradientFormatter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="ae206e2d6a630a7fca11e8e2f55c1649c"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override String Lucene.Net.Search.Highlight.SpanGradientFormatter.HighlightTerm </td> |
| <td>(</td> |
| <td class="paramtype">String </td> |
| <td class="paramname"><em>originalText</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_token_group.html">TokenGroup</a> </td> |
| <td class="paramname"><em>tokenGroup</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_span_gradient_formatter_8cs_source.html#l00041">41</a> of file <a class="el" href="_span_gradient_formatter_8cs_source.html">SpanGradientFormatter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>contrib/Highlighter/<a class="el" href="_span_gradient_formatter_8cs_source.html">SpanGradientFormatter.cs</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 3 2013 02:12:58 for Lucene.Net by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.3 |
| </small></address> |
| </body> |
| </html> |
