Author: echatellier Date: 2010-03-15 15:56:12 +0100 (Mon, 15 Mar 2010) New Revision: 249 Log: Add doc for tree filtering and focusable tooltips Added: trunk/src/site/resources/ trunk/src/site/resources/images/ trunk/src/site/resources/images/components/ trunk/src/site/resources/images/components/focusablett1.jpg trunk/src/site/resources/images/components/focusablett2.jpg trunk/src/site/rst/components/ trunk/src/site/rst/components/focusabletooltips.rst trunk/src/site/rst/components/treefilters.rst trunk/src/site/site_fr.xml Removed: trunk/src/site/site_fr.xml Modified: trunk/src/site/rst/index.rst Added: trunk/src/site/resources/images/components/focusablett1.jpg =================================================================== (Binary files differ) Property changes on: trunk/src/site/resources/images/components/focusablett1.jpg ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/src/site/resources/images/components/focusablett2.jpg =================================================================== (Binary files differ) Property changes on: trunk/src/site/resources/images/components/focusablett2.jpg ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/src/site/rst/components/focusabletooltips.rst =================================================================== --- trunk/src/site/rst/components/focusabletooltips.rst (rev 0) +++ trunk/src/site/rst/components/focusabletooltips.rst 2010-03-15 14:56:12 UTC (rev 249) @@ -0,0 +1,50 @@ +Focusables tooltips +=================== + +Focusable tooltips are eclipse-like tooltips original taken from `RSyntaxTextArea`_ +project. + +The nuiton-widget version also include modification to allow putting focusable +tooltips on non-``JTextArea`` ``JComponent``s. + +Screenshots +----------- + +Default tooltip: + +.. image:: ../images/components/focusablett1.jpg + +Focused tooltip: + +.. image:: ../images/components/focusablett2.jpg + +Using +----- + +To use focusable tooltip, you need to redefine the ``getTooltipText()`` method +on related components :: + + JTable table = new JTable(tableModel) { + /** Single tooltip instance. */ + protected FocusableTip focusableTip; + + @Override + public String getToolTipText(MouseEvent e) { + String text = super.getToolTipText(e); + if (focusableTip == null) { + focusableTip = new FocusableTip(this, null); + } + focusableTip.toolTipRequested(e, text); + + return null; + } + }; + + +Sources +------- + + * `Fifesoft blog`_. + +.. _RSyntaxTextArea: http://fifesoft.com/rsyntaxtextarea/ +.. _Fifesoft blog: http://fifesoft.com/blog/?p=93 \ No newline at end of file Added: trunk/src/site/rst/components/treefilters.rst =================================================================== --- trunk/src/site/rst/components/treefilters.rst (rev 0) +++ trunk/src/site/rst/components/treefilters.rst 2010-03-15 14:56:12 UTC (rev 249) @@ -0,0 +1,44 @@ +Tree filtering +============== + +Nuiton-widget provide basic model based tree filtering. + +API +--- + +Only two classes are provided: + + * TreeFilter : Interface for tree filter implementation + * TreeFilterModel : Filtered tree model + +The TreeFilter currently has only one method ``include`` which must return +``true`` only if parameter node must be displayed. + +Using +----- + +Define your filtered tree:: + + public class Test { + + protected FilterTreeModel filterModel; + + [...] + + protected void buildUI() { + + TreeModel realModel = ... + filterModel = new FilterTreeModel(realModel); + + JTree tree = new JTree(filterModel); + + [...] + } + +Then apply filtering (when filter need to be updated):: + + [...] + protected void updateFilter(String filterString) { + TreeFilter myTreeFilter = new MyTreeFilter(filterString); + filterModel.setTreeFilter(myTreeFilter); + } \ No newline at end of file Modified: trunk/src/site/rst/index.rst =================================================================== --- trunk/src/site/rst/index.rst 2010-03-15 14:08:10 UTC (rev 248) +++ trunk/src/site/rst/index.rst 2010-03-15 14:56:12 UTC (rev 249) @@ -1,4 +1,21 @@ Nuiton widgets ============== -Todo +Swing components set. + +Components +---------- + + * `Tree filters`_. + * `Focusable tooltips`_. + +Others components +----------------- + +Other usefull components but not included in nuiton-widgets. + + * `Datatips`_. + +.. _Tree filters: components/treefilters.html +.. _Focusable tooltips: components/focusabletooltips.html +.. _Datatips: https://datatips.dev.java.net/ \ No newline at end of file Deleted: trunk/src/site/site_fr.xml =================================================================== --- trunk/src/site/site_fr.xml 2010-03-15 14:08:10 UTC (rev 248) +++ trunk/src/site/site_fr.xml 2010-03-15 14:56:12 UTC (rev 249) @@ -1,33 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<project name="${project.name}"> - - <bannerLeft> - <name>${project.name}</name> - <href>index.html</href> - </bannerLeft> - - <poweredBy> - <logo href="http://maven.apache.org" name="Maven" img="images/logos/maven-feather.png"/> - <logo href="http://maven-site.nuiton.org/jrst/" name="JRst" img="images/jrst-logo.png"/> - <logo href="http://docutils.sourceforge.net/rst.html" name="ReStructuredText" img="images/restructuredtext-logo.png"/> - </poweredBy> - - <body> - - <breadcrumbs> - <item name="${project.name}" href="index.html" /> - </breadcrumbs> - - <menu name="Utilisateur"> - <item href="./index.html" name="Accueil"/> - <item href="http://www.nuiton.org/projects/list_files/nuiton-widgets" name="Téléchargement"/> - </menu> - - <menu name="Developpeur"> - <item name="Todo" href="Todo.html"/> - </menu> - - <menu ref="reports"/> - - </body> -</project> Added: trunk/src/site/site_fr.xml =================================================================== --- trunk/src/site/site_fr.xml (rev 0) +++ trunk/src/site/site_fr.xml 2010-03-15 14:56:12 UTC (rev 249) @@ -0,0 +1,37 @@ +<?xml version="1.0" encoding="UTF-8"?> +<project name="${project.name}"> + + <bannerLeft> + <name>${project.name}</name> + <href>index.html</href> + </bannerLeft> + + <poweredBy> + <logo href="http://maven.apache.org" name="Maven" img="images/logos/maven-feather.png"/> + <logo href="http://maven-site.nuiton.org/jrst/" name="JRst" img="images/jrst-logo.png"/> + <logo href="http://docutils.sourceforge.net/rst.html" name="ReStructuredText" img="images/restructuredtext-logo.png"/> + </poweredBy> + + <body> + + <breadcrumbs> + <item name="${project.name}" href="index.html" /> + </breadcrumbs> + + <menu name="Utilisateur"> + <item href="./index.html" name="Accueil"/> + <item name="Composants"> + <item href="components/treefilters.html" name="Tree filters"/> + <item href="components/focusabletooltips.html" name="Focusable tooltips"/> + </item> + </menu> + + <menu name="Developpeur"> + <item href="http://www.nuiton.org/projects/list_files/nuiton-widgets" name="Téléchargement"/> + <item name="Todo" href="Todo.html"/> + </menu> + + <menu ref="reports"/> + + </body> +</project>