{#==========================================
Spincast Locale Resolver plugin
==========================================#}
{% extends "../../layout.html" %}

{% block sectionClasses %}plugins plugins-spincast-locale-resolver{% endblock %}
{% block meta_title %}Plugins - Spincast Locale Resolver{% endblock %}
{% block meta_description %}Spincast Locale Resolver plugin helps find the Locale/Langage to use.{% endblock %}

{% block scripts %}
<script>

    {#==========================================
    Initialize the Table Of Content
    ==========================================#}
    $(function() {
        app.toc(230);
    });

</script>
{% endblock %}

{% block body %}

<div class="container pluginDoc">

    <ol class="breadcrumb">
        <li><img class="inlineIcon breadIcon" src="/public/images/icons/bread.png" /> <a href="/plugins">Plugins</a></li>
        <li class="active">Spincast Locale Resolver plugin</li>
    </ol>
    
    <div id="sectionTitle" class="row"> 
        <div class="col-xs-12">
            <a href="#top"><h2 class="shortTop noBottom"><img class="inlineIcon" src="/public/images/icons/breadPlugin.png" /> Spincast Locale Resolver <span>plugin</span></h2></a>
            <div class="pluginBadges">
                <div class="pluginBadgeTop hint--bottom-left hint--bounce" 
                     data-hint="Plugin's Javadoc">
                     <a href="/public/javadoc/index.html?org/spincast/plugins/localeresolver/package-summary.html"><img class="inlineIcon" src="/public/images/javadoc-badge.png" /></a>
                </div>
                <div class="pluginBadgeTop hint--bottom-left hint--bounce" 
                     data-hint="Core plugin included in the 'spincast-default' artifact"><img class="inlineIcon" src="/public/images/default-badge.png" /></div>
                <span class="clear"></span>
            </div> 
        </div>
    </div>
    
    <div id="sectionTitleFixed" class="row"> 
        <div class="col-xs-12">
            <a href="#top"><h2 class="shortTop"><img src="/public/images/logo_xsmall.png" /> Spincast Locale Resolver <span>plugin</span></h2></a>
        </div>
    </div>

    <div class="row">
        <nav id="toc" class="longTitle col-md-3">
            <ul class="nav nav-stacked">
                <li class="openable"><a href="#top">Overview</a></li>
                <li class="openable"><a href="#installation">Installation</a></li>
                <li class="openable">
                    <a href="#localeresolver">The <code>ILocaleResolver</code> interface</a>
                    <ul class="nav nav-stacked">
                        <li><a href="#methods">Methods</a></li>
                    </ul>
                </li>
            </ul>
        </nav>
        
        <div id="toc-content" class="col-md-9">
        
            <section id="overview">
            
                <h3>
                    <a class="anchor" href="#overview" title="permanent link"></a>
                    Overview
                </h3>
	            <p>
	                The <code>Spincast Locale Resolver</code> plugin provides an implementation 
                    of the <code>ILocaleResolver</code> interface, which is used to find the best locale/language to use
                    for the current request/response exchange.
	            </p>
                
            </section>
            
	        <section id="installation">
                <h3>
                    <a class="anchor" href="#installation" title="permanent link"></a>
                    Installation
                </h3>
	            <p>
	                If you use the <code>spincast-default</code> artifact, this plugin is already installed so
	                you have nothing more to do!
	            </p>
	            <p>
                    <img class="inlineIcon" src="/public/images/icons/para.png" />
	                If you start from scratch using the <code>spincast-core</code> artifact, you can use the
	                plugin by adding this artifact to your project:
	                <div>
	                    <p>
	                        <pre class="ace ace-xml"
>&lt;dependency&gt;
    &lt;groupId&gt;org.spincast&lt;/groupId&gt;
    &lt;artifactId&gt;spincast-plugins-locale-resolver&lt;/artifactId&gt;
    &lt;version&gt;{{spincastCurrrentVersion}}&lt;/version&gt;
&lt;/dependency&gt;</pre> 
	                    </p>
	                </div>  
	            </p>
	            <p>
	                <img class="inlineIcon" src="/public/images/icons/para.png" />
	                You then install the plugin's Guice module, by passing it to the <code>Guice.createInjector(...)</code> method:
	                <div>
	                    <p>
	                        <pre class="ace ace-java" data-ace-hi="2,8,2,110|3,8,3,110"
>Injector guice = Guice.createInjector(
        new SpincastCoreGuiceModule(args),
        new SpincastLocaleResolverPluginGuiceModule(IAppRequestContext.class, 
                                                    IAppWebsocketContext.class)
        // other modules...
        );</pre> 
	                    </p>
	                </div>   
	            </p>
	            <p>
	                ... or by using the <code>install(...)</code> method from your custom Guice module:
	                <div>
	                    <p>
	                        <pre class="ace ace-java" data-ace-hi="5,8,5,87|6,8,6,100"
>public class AppModule extends SpincastCoreGuiceModule {

    @Override
    protected void configure() {
        super.configure();
        install(new SpincastLocaleResolverPluginGuiceModule(getRequestContextType(), 
                                                            getWebsocketContextType()));
        // other modules...
    }
    
    // ...
}</pre> 
	                    </p>
	                </div>   
	            </p>
            </section>
            
            <section id="localeresolver">
            
                <h3 class="noTop">
                     <a class="anchor" href="#localeresolver" title="permanent link"></a>
                    The <code>ILocaleResolver</code> interface
                </h3>
                <p>
                </p> 
                
                <div id="methods">
                    <p>
                        <h4><img class="inlineIcon" src="/public/images/icons/para.png" /> Methods :</h4>
                        <ul class="apiList">
                        
                        
                        
                        
                        
<li>
    <code class="apiItem">Locale <span>getLocaleToUse</span>()</code>
    <div class="well">
        The best Locale to use.

        <div class="apiItemFooter">
            @return The best Locale to use. If none is found, returns
 the <em>default</em> Locale, as defined by <code>ISpincastConfig#getDefaultLocale()</code>

        </div>
    </div>
</li>



                        </ul>
                        
                    </p>
                </div> 
            </section>


        </div>
    </div>
    
</div> 

{% endblock %}