| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_25) on Mon Jul 01 12:09:11 CEST 2013 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>BrandingPlugin (Apache Felix Web Management Console 3.1.2 API)</title> |
| <meta name="date" content="2013-07-01"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="BrandingPlugin (Apache Felix Web Management Console 3.1.2 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../org/apache/felix/webconsole/package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/BrandingPlugin.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/felix/webconsole/AttachmentProvider.html" title="interface in org.apache.felix.webconsole"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/felix/webconsole/ConfigurationPrinter.html" title="interface in org.apache.felix.webconsole"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/felix/webconsole/BrandingPlugin.html" target="_top">Frames</a></li> |
| <li><a href="BrandingPlugin.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All 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> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.felix.webconsole</div> |
| <h2 title="Interface BrandingPlugin" class="title">Interface BrandingPlugin</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/felix/webconsole/DefaultBrandingPlugin.html" title="class in org.apache.felix.webconsole">DefaultBrandingPlugin</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">BrandingPlugin</span></pre> |
| <div class="block">The <code>BrandingPlugin</code> is the service interface for the most |
| elaborate way of branding the web console.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/felix/webconsole/DefaultBrandingPlugin.html" title="class in org.apache.felix.webconsole"><code>DefaultBrandingPlugin</code></a></dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/BrandingPlugin.html#getBrandName()">getBrandName</a></strong>()</code> |
| <div class="block">Returns an indicative name of the branding plugin.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/BrandingPlugin.html#getFavIcon()">getFavIcon</a></strong>()</code> |
| <div class="block">Returns the absolute path to an icon to be used as the web console |
| "favicon".</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/BrandingPlugin.html#getMainStyleSheet()">getMainStyleSheet</a></strong>()</code> |
| <div class="block">Returns the absolute path to a CSS file to be used as the main CSS for |
| the basic admin site.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/BrandingPlugin.html#getProductImage()">getProductImage</a></strong>()</code> |
| <div class="block">Returns an absolute path to an image to be rendered as the logo of the |
| branding product.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/BrandingPlugin.html#getProductName()">getProductName</a></strong>()</code> |
| <div class="block">Returns the name of the product in which the web console is contained |
| and to which the web console is branded.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/BrandingPlugin.html#getProductURL()">getProductURL</a></strong>()</code> |
| <div class="block">Returns an (absolute) URL to a web site representing the product to |
| which the web console is branded.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/BrandingPlugin.html#getVendorImage()">getVendorImage</a></strong>()</code> |
| <div class="block">Returns an absolute path to an image to be rendered as the logo of the |
| branding product vendor.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/BrandingPlugin.html#getVendorName()">getVendorName</a></strong>()</code> |
| <div class="block">Returns the name of the branding product vendor.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/BrandingPlugin.html#getVendorURL()">getVendorURL</a></strong>()</code> |
| <div class="block">Returns an (absolute) URL to the web site of the branding product |
| vendor.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getBrandName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBrandName</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getBrandName()</pre> |
| <div class="block">Returns an indicative name of the branding plugin. This value is used |
| as the Window/Page title together with the title of the respective |
| plugin.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the name of the branding plugin</dd></dl> |
| </li> |
| </ul> |
| <a name="getProductName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProductName</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getProductName()</pre> |
| <div class="block">Returns the name of the product in which the web console is contained |
| and to which the web console is branded.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the product name</dd></dl> |
| </li> |
| </ul> |
| <a name="getProductURL()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProductURL</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getProductURL()</pre> |
| <div class="block">Returns an (absolute) URL to a web site representing the product to |
| which the web console is branded.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the product URL</dd></dl> |
| </li> |
| </ul> |
| <a name="getProductImage()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProductImage</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getProductImage()</pre> |
| <div class="block">Returns an absolute path to an image to be rendered as the logo of the |
| branding product.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>a path to an image - usually the product logo</dd></dl> |
| </li> |
| </ul> |
| <a name="getVendorName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getVendorName</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getVendorName()</pre> |
| <div class="block">Returns the name of the branding product vendor.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the product vendor</dd></dl> |
| </li> |
| </ul> |
| <a name="getVendorURL()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getVendorURL</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getVendorURL()</pre> |
| <div class="block">Returns an (absolute) URL to the web site of the branding product |
| vendor.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the URL of the product vendor</dd></dl> |
| </li> |
| </ul> |
| <a name="getVendorImage()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getVendorImage</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getVendorImage()</pre> |
| <div class="block">Returns an absolute path to an image to be rendered as the logo of the |
| branding product vendor.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the company logo</dd></dl> |
| </li> |
| </ul> |
| <a name="getFavIcon()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFavIcon</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getFavIcon()</pre> |
| <div class="block">Returns the absolute path to an icon to be used as the web console |
| "favicon".</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>path to an image, that is shown as favorite icon in the web browser</dd></dl> |
| </li> |
| </ul> |
| <a name="getMainStyleSheet()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getMainStyleSheet</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getMainStyleSheet()</pre> |
| <div class="block">Returns the absolute path to a CSS file to be used as the main CSS for |
| the basic admin site.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>a path to a custom CSS. Used to override the default web console styling</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../org/apache/felix/webconsole/package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/BrandingPlugin.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/felix/webconsole/AttachmentProvider.html" title="interface in org.apache.felix.webconsole"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/felix/webconsole/ConfigurationPrinter.html" title="interface in org.apache.felix.webconsole"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/felix/webconsole/BrandingPlugin.html" target="_top">Frames</a></li> |
| <li><a href="BrandingPlugin.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All 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> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2006–2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
