diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3bb1d418..d6847021 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -67,8 +67,8 @@ One of the committers will take a look and provide feedback or merge your contri That's it, thanks for contributing to Sisu! -[ECA]: https://www.eclipse.org/legal/ECA.php -[issue-tracker]: https://github.com/eclipse/sisu.inject/issues +[ECA]: https://www.eclipse.org/legal/eca/ +[issue-tracker]: https://github.com/eclipse-sisu/sisu-project/issues [style-guide]: https://maven.apache.org/developers/conventions/code.html [rebase]: https://github.com/edx/edx-platform/wiki/How-to-Rebase-a-Pull-Request [github-issue]: https://help.github.com/articles/closing-issues-via-commit-messages/ diff --git a/README.md b/README.md index 1d0c62fa..cff42b8a 100644 --- a/README.md +++ b/README.md @@ -12,40 +12,14 @@ [![maintainability](https://sonarcloud.io/api/project_badges/measure?project=eclipse-sisu_sisu.inject&metric=sqale_rating)](https://sonarcloud.io/summary/overall?id=eclipse-sisu_sisu.inject) [![license](https://img.shields.io/badge/license-EPL_1.0-blue.svg)](https://www.eclipse.org/legal/epl-v10.html) -Sisu is a modular [JSR330](https://javax-inject.github.io/javax-inject/)-based container that supports classpath scanning, auto-binding, and dynamic auto-wiring. +Sisu is a modular [JSR-330](https://javax-inject.github.io/javax-inject/)-based container that supports classpath scanning, auto-binding, and dynamic auto-wiring. -Sisu uses [Google-Guice](https://github.com/google/guice) to perform dependency injection and provide the core JSR330 support, but removes the need to write explicit bindings in Guice modules. Integration with other containers via the Eclipse Extension Registry and the OSGi Service Registry is a goal of this project. - -## Maven - -```xml - - org.eclipse.sisu - org.eclipse.sisu.inject - 0.3.5 - -``` +Sisu uses [Google Guice](https://github.com/google/guice) to perform dependency injection and provide the core JSR-330 support, but removes the need to write explicit bindings in Guice modules. Integration with other containers via the Eclipse Extension Registry and the OSGi Service Registry is a goal of this project. ## Documentation -[Sisu in 5 minutes](https://eclipse.github.io/sisu.inject/) - -[Javadoc](https://eclipse.github.io/sisu.inject/apidocs/) - -### Generation of Named Index - -Often Sisu's `SpaceModule` doesn't scan the full classpath at run time (for relevant annotations) but relies on a pre-generated index at `META-INF/sisu/javax.inject.Named`. There are two different ways how to create such an index file: - -1. By leveraging the Java annotation processor in [org.eclipse.sisu.space.SisuIndexAPT6](https://github.com/eclipse/sisu.inject/blob/master/org.eclipse.sisu.inject/src/main/java/org/eclipse/sisu/space/SisuIndexAPT6.java) to generate the index. One needs to enable via [`javac -processor org.eclipse.sisu.space.SisuIndexAPT6`](https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#annotation-processing) or with the according [`maven-compiler-plugin` parameter `annotationProcessors`](https://maven.apache.org/plugins/maven-compiler-plugin/compile-mojo.html#annotationProcessors). -2. By leveraging the dedicated Maven plugin - -## Related projects - -https://github.com/eclipse/sisu.mojos/ - * a [Maven](https://maven.apache.org/) plugin that generates annotation indexes for Sisu to avoid classpath scanning at runtime - -https://github.com/eclipse/sisu.plexus/ - * an extension that implements [Plexus](https://codehaus-plexus.github.io/#Plexus_History) container API and injection semantics on top of Sisu +* [Sisu Website](https://eclipse.github.io/sisu.inject/) (soon also available on ) +* [Eclipse Project Information](https://projects.eclipse.org/projects/technology.sisu) ## How to Contribute @@ -53,16 +27,4 @@ We accept contributions via GitHub pull requests. Please see [How To Contribute] ## License -- [Eclipse Public License, v1.0](https://www.eclipse.org/legal/epl-v10.html) - -## Meaning of sisu -From https://en.wikipedia.org/w/index.php?title=Sisu&oldid=371994592 - -> Sisu is a Finnish term loosely translated into English as strength of will, determination, perseverance, and acting rationally in the face of adversity. However, the word is widely considered to lack a proper translation into any language. Sisu has been described as being integral to understanding Finnish culture. The literal meaning is equivalent in English to "having guts", and the word derives from sisus, which means something inner or interior. However sisu is defined by a long-term element in it; it is not momentary courage, but the ability to sustain an action against the odds. Deciding on a course of action and the sticking to that decision against repeated failures is sisu. It is similar to equanimity, except the forbearance of sisu has a grimmer quality of stress management than the latter. The noun sisu is related to the adjective sisukas, one having the quality of sisu. - -## Additional information - -* Project Website: https://www.eclipse.org/sisu -* Mailing Lists: https://dev.eclipse.org/mailman/listinfo/sisu-dev -* Eclipse PMI: https://projects.eclipse.org/projects/technology.sisu - +- [Eclipse Public License, v2.0](https://www.eclipse.org/legal/epl-v20.html) \ No newline at end of file diff --git a/RELEASE.md b/RELEASE.md index d0757095..896d14ec 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -1,5 +1,9 @@ # Releasing Sisu +## Eclipse Foundation Release Policy + + + ## Maven Note: Build uses latest `maven-gpg-plugin` and is getting rid "old bad practices" of storing sensitive information in @@ -11,7 +15,7 @@ See [maven-gpg-plugin site](https://maven.apache.org/plugins/maven-gpg-plugin/us ### Release steps -Prerequsites: +**Prerequisites:** * deploy snapshot: `mvn deploy -P sisu-release` for testing * make sure source code does not have `@since TBD`; of have, search/replace it with upcoming version * perform the release @@ -19,8 +23,8 @@ Prerequsites: The "usual" Maven release: * `mvn release:prepare` * `mvn release:perform` -* project uses https://oss.sonatype.org/ to stage (manual step: close and release staging repository) +* project uses to stage (manual step: close and release staging repository) ## Site -TBD +Look at https://eclipse.dev/sisu/development.html#Site_Publishing diff --git a/docs/.nojekyll b/docs/.nojekyll deleted file mode 100644 index e69de29b..00000000 diff --git a/docs/apidocs/assets/customizations.css b/docs/apidocs/assets/customizations.css deleted file mode 100644 index 5023a63f..00000000 --- a/docs/apidocs/assets/customizations.css +++ /dev/null @@ -1,59 +0,0 @@ -#header { - background-color: #686884; - border-bottom: 3px solid #686884; -} -#masthead-title { - font-family: courier, monospace; - color: #FFFFFF; -} -#search_filtered .jd-selected { - background-color: #686884; -} -#search_filtered_div { - border: 1px solid #686884; -} -input.gsc-input { - border: 1px solid #D8D8E2; -} -#resize-packages-nav { - height: 225px; -} -#packages-nav { - height: 225px; -} -#side-nav .selected { - background-color: #686884; -} -#index-links .selected { - background-color: #FFFFFF; -} -#jd-header { - background-color: #D8D8E2; -} -th { - background-color: #D8D8E2; -} -tr.alt-color { - background-color: #F0F0F5 !important; -} -a, a:link, a code, a:link code { - color: #558; -} -a:active, a:active code { - color: #558; -} -a:visited, a:visited code { - color: #558; -} -#jd-content h1 { - color:#111; -} -#jd-content h2 { - color:#111; -} -#jd-content h3 { - color:#111; -} -#searchForm { - width:210px; -} diff --git a/docs/apidocs/assets/customizations.js b/docs/apidocs/assets/customizations.js deleted file mode 100644 index e69de29b..00000000 diff --git a/docs/apidocs/assets/doclava-developer-core.css b/docs/apidocs/assets/doclava-developer-core.css deleted file mode 100644 index e68dde48..00000000 --- a/docs/apidocs/assets/doclava-developer-core.css +++ /dev/null @@ -1,693 +0,0 @@ -/* file: doclava-developer-core.css - info: core developer styles -*/ - -/* RESET STYLES */ - -html,body,div,h1,h2,h3,h4,h5,h6,p,img, -dl,dt,dd,ol,ul,li,table,caption,tbody, -tfoot,thead,tr,th,td,form,fieldset, -embed,object,applet { - margin: 0; - padding: 0; - border: 0; -} - -/* BASICS */ - -html, body { - overflow:hidden; /* keeps scrollbar off IE */ - background-color:#fff; -} - -body { - font-family:arial,sans-serif; - color:#000; - font-size:13px; - color:#333; - background-image:url(images/bg_fade.jpg); - background-repeat:repeat-x; -} - -a, a code { - color:#006699; -} - -a:active, -a:active code { - color:#f00; -} - -a:visited, -a:visited code { - color:#006699; -} - -input, select, -textarea, option, label { - font-family:inherit; - font-size:inherit; - padding:0; - margin:0; - vertical-align:middle; -} - -option { - padding:0 4px; -} - -p { - padding:0; - margin:0 0 1em; -} - -code, pre { - color:#007000; - font-family:monospace; - line-height:1em; -} - -var { - color:#007000; - font-style:italic; -} - -pre { - border:1px solid #ccc; - background-color:#fafafa; - padding:10px; - margin:0 0 1em 1em; - overflow:auto; - line-height:inherit; /* fixes vertical scrolling in webkit */ -} - -h1,h2,h3,h4,h5 { - margin:1em 0; - padding:0; -} - -p,ul,ol,dl,dd,dt,li { - line-height:1.3em; -} - -ul,ol { - margin:0 0 .8em; - padding:0 0 0 2em; -} - -li { - padding:0 0 .5em; -} - -dl { - margin:0 0 1em 0; - padding:0; -} - -dt { - margin:0; - padding:0; -} - -dd { - margin:0 0 1em; - padding:0 0 0 2em; -} - -li p { - margin:.5em 0 0; -} - -dd p { - margin:1em 0 0; -} - -li pre, li table, li img { - margin:.5em 0 0 1em; -} - -dd pre, -#jd-content dd table, -#jd-content dd img { - margin:1em 0 0 1em; -} - -li ul, -li ol, -dd ul, -dd ol { - margin:0; - padding: 0 0 0 2em; -} - -li li, -dd li { - margin:0; - padding:.5em 0 0; -} - -dl dl, -ol dl, -ul dl { - margin:0 0 1em; - padding:0; -} - -table { - font-size:1em; - margin:0 0 1em; - padding:0; - border-collapse:collapse; - border-width:0; - empty-cells:show; -} - -td,th { - border:1px solid #ccc; - padding:6px 12px; - text-align:left; - vertical-align:top; - background-color:inherit; -} - -th { - background-color:#dee8f1; -} - -td > p:last-child { - margin:0; -} - -hr.blue { - background-color:#DDF0F2; - border:none; - height:5px; - margin:20px 0 10px; -} - -blockquote { - margin: 0 0 1em 1em; - padding: 0 4em 0 1em; - border-left:2px solid #eee; -} -/* LAYOUT */ - -#body-content { - /* "Preliminary" watermark for draft documentation. - background:transparent url(images/preliminary.png) repeat scroll 0 0; */ - margin:0; - position:relative; - width:100%; -} - -#header { - height: 44px; - position:relative; - z-index:100; - min-width:675px; /* min width for the tabs, before they wrap */ - padding:0 10px; - border-bottom:3px solid #94b922; -} - -#headerLeft{ - position:absolute; - padding: 10px 0 0; - left:8px; - bottom:3px; -} - -#headerRight { - position:absolute; - right:0; - bottom:3px; - padding:0; - text-align:right; -} - -#masthead-title { - font-size:28px; - color: #2f74ae; -} - -/* Tabs in the header */ - -#header ul { - list-style: none; - margin: 7px 0 0; - padding: 0; - height: 29px; -} - -#header li { - float: left; - margin: 0px 2px 0px 0px; - padding:0; -} - -#header li a { - text-decoration: none; - display: block; - background-image: url(images/bg_images_sprite.png); - background-position: 0 -58px; - background-repeat: no-repeat; - color: #666; - font-size: 13px; - font-weight: bold; - width: 94px; - height: 29px; - text-align: center; - margin: 0px; -} - -#header li a:hover { - background-image: url(images/bg_images_sprite.png); - background-position: 0 -29px; - background-repeat: no-repeat; -} - -#header li a span { - position:relative; - top:7px; -} - -#header li a span+span { - display:none; -} - -/* tab highlighting */ - -.home #home-link a, -.guide #guide-link a, -.reference #reference-link a, -.sdk #sdk-link a, -.resources #resources-link a, -.videos #videos-link a { - background-image: url(images/bg_images_sprite.png); - background-position: 0 0; - background-repeat: no-repeat; - color: #fff; - font-weight: bold; - cursor:default; -} - -.home #home-link a:hover, -.guide #guide-link a:hover, -.reference #reference-link a:hover, -.sdk #sdk-link a:hover, -.resources #resources-link a:hover, -.videos #videos-link a:hover { - background-image: url(images/bg_images_sprite.png); - background-position: 0 0; -} - -#headerLinks { - margin:10px 10px 0 0; - height:13px; - font-size: 11px; - vertical-align: top; -} - -#headerLinks a { - color: #7FA9B5; -} - -#headerLinks img { - vertical-align:middle; -} - -#language { - margin:0 10px 0 4px; -} - -#search { - margin:8px 10px 0 0; -} - -/* MAIN BODY */ - -#mainBodyFluid { - margin: 20px 10px; - color:#333; -} - -#mainBodyFixed { - margin: 20px 10px; - color: #333; - width:930px; - position:relative; -} - -#mainBodyFixed h3, -#mainBodyFluid h3 { - color:#336666; - font-size:1.25em; - margin: 0em 0em 0em 0em; - padding-bottom:.5em; -} - -#mainBodyFixed h2, -#mainBodyFluid h2 { - color:#336666; - font-size:1.25em; - margin: 0; - padding-bottom:.5em; -} - -#mainBodyFixed h1, -#mainBodyFluid h1 { - color:#435A6E; - font-size:1.7em; - margin: 1em 0; -} - -#mainBodyFixed .green, -#mainBodyFluid .green, -#jd-content .green { - color:#7BB026; - background-color:none; -} - -#mainBodyLeft { - float: left; - width: 600px; - margin-right: 20px; - color: #333; - position:relative; -} - -div.indent { - margin-left: 40px; - margin-right: 70px; -} - -#mainBodyLeft p { - color: #333; - font-size: 13px; -} - -#mainBodyLeft p.blue { - color: #669999; -} - -#mainBodyLeft #communityDiv { - float: left; - background-image:url(images/bg_community_leftDiv.jpg); - background-repeat: no-repeat; - width: 581px; - height: 347px; - padding: 20px 0px 0px 20px; -} - -#mainBodyRight { - float: left; - width: 300px; - color: #333; -} - -#mainBodyRight p { - padding-right: 50px; - color: #333; -} - -#mainBodyRight table { - width: 100%; -} - -#mainBodyRight td { - border:0px solid #666; - padding:0px 5px; - text-align:left; -} - -#mainBodyRight td p { - margin:0 0 1em 0; -} - -#mainBodyRight .blueBorderBox { - border:5px solid #ddf0f2; - padding:18px 18px 18px 18px; - text-align:left; -} - -#mainBodyFixed .seperator { - background-image:url(images/hr_gray_side.jpg); - background-repeat:no-repeat; - width: 100%; - float: left; - clear: both; -} - -#mainBodyBottom { - float: left; - width: 100%; - clear:both; - color: #333; -} - -#mainBodyBottom .seperator { - background-image:url(images/hr_gray_main.jpg); - background-repeat:no-repeat; - width: 100%; - float: left; - clear: both; -} - -/* FOOTER */ - -#footer { - float: left; - width:90%; - margin: 20px; - color: #aaa; - font-size: 11px; -} - -#footer a { - color: #aaa; - font-size: 11px; -} - -#footer a:hover { - text-decoration: underline; - color:#aaa; -} - -#footerlinks { - margin-top:2px; -} - -#footerlinks a, -#footerlinks a:visited { - color:#006699; -} - -/* SEARCH FILTER */ - -#search_autocomplete { - color:#aaa; -} - -#search-button { - display:inline; -} - -#search_filtered_div { - position:absolute; - margin-top:-1px; - z-index:101; - border:1px solid #BCCDF0; - background-color:#fff; -} - -#search_filtered { - min-width:100%; -} -#search_filtered td{ - background-color:#fff; - border-bottom: 1px solid #669999; - line-height:1.5em; -} - -#search_filtered .jd-selected { - background-color: #94b922; - cursor:pointer; -} -#search_filtered .jd-selected, -#search_filtered .jd-selected a { - color:#fff; -} - -.no-display { - display: none; -} - -.jd-autocomplete { - font-family: Arial, sans-serif; - padding-left: 6px; - padding-right: 6px; - padding-top: 1px; - padding-bottom: 1px; - font-size: 0.81em; - border: none; - margin: 0; - line-height: 1.05em; -} - -.show-row { - display: table-row; -} -.hide-row { - display: hidden; -} - -/* SEARCH */ - -/* restrict global search form width */ -#searchForm { - width:350px; -} - -#searchTxt { - width:200px; -} - -/* disable twiddle and size selectors for left column */ -#leftSearchControl div { - width: 100%; -} - -#leftSearchControl .gsc-twiddle { - background-image : none; -} - -#leftSearchControl td, #searchForm td { - border: 0px solid #000; -} - -#leftSearchControl .gsc-resultsHeader .gsc-title { - padding-left : 0px; - font-weight : bold; - font-size : 13px; - color:#006699; - display : none; -} - -#leftSearchControl .gsc-resultsHeader div.gsc-results-selector { - display : none; -} - -#leftSearchControl .gsc-resultsRoot { - padding-top : 6px; -} - -#leftSearchControl div.gs-visibleUrl-long { - display : block; - color:#006699; -} - -.gsc-webResult div.gs-visibleUrl-short, -table.gsc-branding, -.gsc-clear-button { - display : none; -} - -.gsc-cursor-box .gsc-cursor div.gsc-cursor-page, -.gsc-cursor-box .gsc-trailing-more-results a.gsc-trailing-more-results, -#leftSearchControl a, -#leftSearchControl a b { - color:#006699; -} - -.gsc-resultsHeader { - display: none; -} - -/* Disable built in search forms */ -.gsc-control form.gsc-search-box { - display : none; -} -table.gsc-search-box { - margin:6px 0 0 0; - border-collapse:collapse; -} - -td.gsc-input { - padding:0 2px; - width:100%; - vertical-align:middle; -} - -input.gsc-input { - border:1px solid #BCCDF0; - width:99%; - padding-left:2px; - font-size:.95em; -} - -td.gsc-search-button { - text-align: right; - padding:0; - vertical-align:top; -} - -#search-button { - margin:0 0 0 2px; - font-size:11px; -} - -/* search result tabs */ - -#doc-content .gsc-control { - position:relative; -} - -#doc-content .gsc-tabsArea { - position:relative; - white-space:nowrap; -} - -#doc-content .gsc-tabHeader { - padding: 3px 6px; - position:relative; -} - -#doc-content .gsc-tabHeader.gsc-tabhActive { - border-top: 2px solid #94B922; -} - -#doc-content h2#searchTitle { - padding:0; -} - -#doc-content .gsc-resultsbox-visible { - padding:1em 0 0 6px; -} - -/* Pretty printing styles. Used with prettify.js. */ - -.str { color: #080; } -.kwd { color: #008; } -.com { color: #800; } -.typ { color: #606; } -.lit { color: #066; } -.pun { color: #660; } -.pln { color: #000; } -dl.tag-list dt code, -.tag { color: #008; } -dl.atn-list dt code, -.atn { color: #828; } -.atv { color: #080; } -.dec { color: #606; } - -@media print { - .str { color: #060; } - .kwd { color: #006; font-weight: bold; } - .com { color: #600; font-style: italic; } - .typ { color: #404; font-weight: bold; } - .lit { color: #044; } - .pun { color: #440; } - .pln { color: #000; } - .tag { color: #006; font-weight: bold; } - .atn { color: #404; } - .atv { color: #060; } -} \ No newline at end of file diff --git a/docs/apidocs/assets/doclava-developer-docs.css b/docs/apidocs/assets/doclava-developer-docs.css deleted file mode 100644 index df4e634e..00000000 --- a/docs/apidocs/assets/doclava-developer-docs.css +++ /dev/null @@ -1,1155 +0,0 @@ -/* file: doclava-developer-docs.css - info: developer doc styles -*/ - -@import url("doclava-developer-core.css"); - -#title { - border-bottom: 4px solid #ccc; - display:none; -} - -#title h1 { - color:#336666; - margin:0; - padding: 5px 10px; - font-size: 1em; - line-height: 15px; -} - -#title h1 .small{ - color:#000; - margin:0; - font-size: 13px; - padding:0 0 0 15px; -} - -/* SIDE NAVIGATION */ - -#side-nav { - padding:0 6px 0 0; - background-color: #fff; - font-size:12px; -} - -#side-nav.not-resizable { - background:url('images/sidenav-rule.png') no-repeat 243px 0; -} - -#resize-packages-nav { -/* keeps the resize handle below the h-scroll handle */ - height:270px; - overflow:hidden; - max-height:100%; -} - -#packages-nav { - height:270px; - max-height:inherit; - position:relative; - overflow:auto; -} - -#classes-nav, -#devdoc-nav { - overflow:auto; - position:relative; -} - -#side-nav ul { - list-style: none; - margin: 0; - padding:5px 0; -} - -#side-nav ul ul { - margin: .35em 0 0 0; - padding: 0; -} - -#side-nav li { - padding:0; - line-height:16px; - white-space:nowrap; - zoom:1; -} - -#side-nav li h2 { - font-size:12px; - font-weight: bold; - margin:.5em 0 0 0; - padding: 3px 0 1px 9px; -} - -#side-nav li a { - text-decoration:none; - padding: 0 0 0 18px; - zoom:1; -} - -#side-nav li a span+span { - display:none; -} - -#side-nav li a:hover { - text-decoration:underline; -} - -#side-nav li a+a { - padding: 0; -} -/*second level (nested) list*/ -#side-nav li li li a { - padding: 0 0 0 28px; -} -/*third level (nested) list*/ -#side-nav li li li li a { - padding: 0 0 0 38px; -} - -#side-nav .selected { - background-color: #435a6e; - color: #fff; - font-weight:bold; -} - -#side-nav .selected a { - color: #fff; - text-decoration:none; -} - -#side-nav strong { - display:block; -} - -#side-nav .toggle-list .toggle-img { - margin:0; - padding:0; - position:absolute; - top:0; - left:0; - height:16px; - width:15px; - outline-style:none; -} -/* second-level toggle */ -#side-nav .toggle-list .toggle-list .toggle-img { - left:10px; -} - -#side-nav .closed .toggle-img, -#side-nav .open .closed .toggle-img { - background:url('images/triangle-closed-small.png') 7px 4px no-repeat; -} -#side-nav .open .toggle-img { - background:url('images/triangle-opened-small.png') 7px 4px no-repeat; -} - -#side-nav .toggle-list { - position:relative; -} - -#side-nav .toggle-list ul { - margin:0; - display:none; -} - -#side-nav .toggle-list div { - display:block; -} - -#index-links .selected { - background-color: #fff; - color: #000; - font-weight:normal; - text-decoration:none; -} - -#index-links { - padding:7px 0 4px 10px; -} - -/* nav tree */ - -#nav-tree ul { - padding:5px 0 1.5em; -} - -#side-nav #nav-tree ul li a, -#side-nav #nav-tree ul li span.no-children { - padding: 0 0 0 0; - margin: 0; -} - -#nav-tree .plus { - margin: 0 3px 0 0; -} - -#nav-tree ul ul { - list-style: none; - margin: 0; - padding: 0 0 0 0; -} - -#nav-tree ul li { - margin: 0; - padding: 0 0 0 0; - white-space: nowrap; -} - -#nav-tree .children_ul { - margin:0; -} - -#nav-tree a.nolink { - color: black; - text-decoration: none; -} - -#nav-tree span.label { - width: 100%; -} - -#nav-tree { - overflow-x: auto; - overflow-y: scroll; -} - -#nav-swap { - font-size:10px; - line-height:10px; - margin-left:1em; - text-decoration:none; - display:block; - position:absolute; - bottom:2px; - left:0px; -} - -#tree-link { - -} - -/* DOCUMENT BODY */ - -#doc-content { - overflow:auto; -} - -#jd-header { - background-color: #E2E2E2; - padding: 7px 15px; -} - -#jd-header h1 { - margin: 0 0 10px; - font-size:1.7em; -} - -#jd-header .crumb { - font-size:.9em; - line-height:1em; - color:#777; -} - -#jd-header .crumb a, -#jd-header .crumb a:visited { - text-decoration:none; - color:#777; -} - -#jd-header .crumb a:hover { - text-decoration:underline; -} - -#jd-header table { - margin:0; - padding:0; -} - -#jd-header td { - border:none; - padding:0; - vertical-align:top; -} - -#jd-header.guide-header { - background-color:#fff; - color:#435a6e; - height:50px; -} - -#jd-descr { - position:relative; -} - -/* summary tables for reference pages */ -.jd-sumtable { - margin: .5em 1em 1em 1em; - width:95%; /* consistent table widths; within IE's quirks */ - font-size:.9em; -} - -.jd-sumtable a { - text-decoration:none; -} - -.jd-sumtable a:hover { - text-decoration:underline; -} - -/* the link inside a sumtable for "Show All/Hide All" */ -.toggle-all { - display:block; - float:right; - font-weight:normal; - font-size:0.9em; -} - -/* adjustments for in/direct subclasses tables */ -.jd-sumtable-subclasses { - margin: 1em 0 0 0; - max-width:968px; -} - -/* extra space between end of method name and open-paren */ -.sympad { - margin-right: 2px; -} - -/* right alignment for the return type in sumtable */ -.jd-sumtable .jd-typecol { - text-align:right; - white-space: nowrap; -} - -/* adjustments for the expando table-in-table */ -.jd-sumtable-expando { - margin:.5em 0; - padding:0; -} - -/* a div that holds a short description */ -.jd-descrdiv { - padding:3px 1em 0 1em; - margin:0; - border:0; -} - -/* page-top-right container for reference pages (holds -links to summary tables) */ -#api-info-block { - font-size:.8em; - padding:6px 10px; - font-weight:normal; - float:right; - text-align:right; - color:#999; - max-width:70%; -} - -#api-level-toggle { - padding:0 0px; - font-size:11px; - margin:3px 10px 0 0; -} - -#api-level-toggle label.disabled { - color:#999; -} - -div.api-level { - font-size:.8em; - font-weight:normal; - color:#999; - float:right; - padding:0 7px 0; - margin-top:-25px; -} - -#api-info-block div.api-level { - font-size:1.3em; - font-weight:bold; - float:none; - color:#444; - padding:0; - margin:0; -} - -/* Force link colors for IE6 */ -div.api-level a { - color:#999; -} -#api-info-block div.api-level a:link { - color:#444; -} -#api-level-toggle a { - color:#999; -} - -div#naMessage { - display:none; - width:555px; - height:0; - margin:0 auto; -} - -div#naMessage div { - width:450px; - position:fixed; - margin:50px 0; - padding:4em 4em 3em; - background:#FFF; - background:rgba(255,255,255,0.7); - border:1px solid #dddd00; -} -/* IE6 can't position fixed */ -* html div#naMessage div { position:absolute; } - -div#naMessage strong { - font-size:1.1em; -} - -.absent, -.absent a:link, -.absent a:visited, -.absent a:hover, -.absent * { - color:#bbb !important; - cursor:default !important; - text-decoration:none !important; -} - -#api-level-toggle a, -.api-level a { - color:inherit; - text-decoration:none; -} - -#api-level-toggle a:hover, -.api-level a:hover { - color:inherit; - text-decoration:underline !important; - cursor:pointer !important; -} - -#side-nav li.absent.selected, -#side-nav li.absent.selected *, -#side-nav div.label.absent.selected, -#side-nav div.label.absent.selected * { - background-color:#eaeaea !important; -} -/* IE6 quirk (won't chain classes, so just keep background blue) */ -* html #side-nav li.selected, -* html #side-nav li.selected *, -* html #side-nav div.label.selected, -* html #side-nav div.label.selected * { - background-color: #435a6e !important; -} - - -.absent h4.jd-details-title, -.absent h4.jd-details-title * { - background-color:#f6f6f6 !important; -} - -.absent img { - opacity: .3; - filter: alpha(opacity=30); - -ms-filter:"progid:DXImageTransform.Microsoft.Alpha(Opacity=30)"; -} - - -/* applies to a div containing links to summary tables */ -.sum-details-links { - padding:0; - font-weight:normal; -} - -.sum-details-links a { - text-decoration:none; -} - -.sum-details-links a:hover { - text-decoration:underline; -} - - -/* inheritance table */ -.jd-inheritance-table { - border-spacing:0; - margin:0; - padding:0; - font-size:.9em; -} -.jd-inheritance-table td { - border: none; - margin: 0; - padding: 0; -} -.jd-inheritance-table .jd-inheritance-space { - font-weight:bold; - width:1em; -} -.jd-inheritance-table .jd-inheritance-interface-cell { - padding-left: 17px; -} - -#jd-content { - padding: 18px 15px; -} - -hr { - background-color:#ccc; - border-color:#fff; - margin:2em 0 1em; -} - -/* DOC CLASSES */ - -#jd-content h1 { -/*sdk page*/ - font-size:1.6em; - color:#336666; - margin:0 0 .5em; -} - -#jd-content h2 { - font-size:1.45em; - color:#111; - border-top:2px solid #ccc; - padding: .5em 0 0; - margin: 2em 0 1em 0; -} - -#jd-content h3 { - font-size:1.2em; - color:#222; - padding: .75em 0 .65em 0; - margin:0; -} - -#jd-content h4 { - font-size:1.1em; - margin-bottom:.5em; - color:#222; -} - -#jd-content .small-header { - font-size:1em; - color:#000; - font-weight:bold; - border:none; - padding:0; - margin:1em 0 .5em; - position:inherit; -} - -#jd-content table { - margin: 0 0 1em 1em; -} - -#jd-content img { - margin: 0 0 1em 1em; -} - -#jd-content li img, -#jd-content dd img { - margin:.5em 0 0 1em; -} - -.nolist { - list-style:none; - padding:0; - margin:0 0 1em 1em; -} - -.nolist li { - padding:0 0 2px; - margin:0; -} - -h4 .normal { - font-size:.9em; - font-weight:normal; -} - -.caps { - font-variant:small-caps; - font-size:1.2em; -} - -dl.tag-list dl.atn-list { - padding:0 0 0 2em; -} - -.jd-details { -/* border:1px solid #669999; - padding:4px; */ - margin:0 0 1em; -} - -/* API reference: a container for the -.tagdata blocks that make up the detailed -description */ -.jd-details-descr { - padding:0; - margin:.5em .25em; -} - -/* API reference: a block containing -a detailed description, a params table, -seealso list, etc */ -.jd-tagdata { - margin:.5em 1em; -} - -.jd-tagdata p { - margin:0 0 1em 1em; -} - -/* API reference: adjustments to -the detailed description block */ -.jd-tagdescr { - margin:.25em 0 .75em 0; - line-height:1em; -} - -.jd-tagdescr p { - margin:.5em 0; - padding:0; - -} - -.jd-tagdescr ol, -.jd-tagdescr ul { - margin:0 2.5em; - padding:0; -} - -.jd-tagdescr table, -.jd-tagdescr img { - margin:.25em 1em; -} - -.jd-tagdescr li { -margin:0 0 .25em 0; -padding:0; -} - -/* API reference: heading marking -the details section for constants, -attrs, methods, etc. */ -h4.jd-details-title { - font-size:1.15em; - background-color: #E2E2E2; - margin:1.5em 0 .6em; - padding:3px 95px 3px 3px; /* room for api-level */ -} - -h4.jd-tagtitle { - margin:0; -} - -/* API reference: heading for "Parameters", "See Also", etc., -in details sections */ -h5.jd-tagtitle { - margin:0 0 .25em 0; - font-size:1em; -} - -.jd-tagtable { - margin:0; -} - -.jd-tagtable td, -.jd-tagtable th { - border:none; - background-color:#fff; - vertical-align:top; - font-weight:normal; - padding:2px 10px; -} - -.jd-tagtable th { - font-style:italic; -} - -#jd-content table h2 { - background-color: #d6d6d6; - font-size: 1.1em; - margin:0 0 10px; - padding:5px; - left:0; - width:auto; -} - -div.special { - padding: .5em 1em 1em 1em; - margin: 0 0 1em; - background-color: #DAF3FC; - border:1px solid #d3ecf5; - border-radius:5px; - -moz-border-radius:5px; - -webkit-border-radius:5px; -} - -.toggle-content-toggleme { - display:none; -} - -.toggle-content-button { - font-size:.9em; - line-height:.9em; - text-decoration:none; - position:relative; - top:5px; -} - -.toggle-content-button:hover { - text-decoration:underline; -} - -div.special p { - margin: .5em 0 0 0; -} - -div.special ol { - margin: 0; -} - -div.special ol li { - margin: 0; - padding: 0; -} - -#jd-content div.special h2, -#jd-content div.special h3 { - color:#669999; - font-size:1.2em; - border:none; - margin:0 0 .5em; - padding:0; -} - -p.note, p.caution, p.warning { - margin: 1em; - padding: 0 0 0 .5em; - border-left: 4px solid; -} - -p.special-note { - background-color:#EBF3DB; - padding:10px 20px; - margin:0 0 1em; -} - -p.note { - border-color: #99aacc; -} - -p.warning { - border-color: #aa0033; -} - -p.caution { - border-color: #ffcf00; -} - -p.warning b, p.warning strong { - font-weight: bold; -} - -li p.note, li p.warning { - margin: .5em 0 0 0; - padding: .2em .5em .2em .9em; -} - -dl.xml dt { - font-variant:small-caps; - font-size:1.2em; -} - -dl.xml dl { - padding:0; -} - -dl.xml dl dt { - font-variant:normal; - font-size:1em; -} - -.listhead li { - font-weight: bold; -} - -.listhead li *, /*ie*/.listhead li li { - font-weight: normal; -} - -ol.no-style, -ul.no-style { - list-style:none; - padding-left:1em; -} - -.new { - font-size: .78em; - font-weight: bold; - color: #ff3d3d; - text-decoration: none; - vertical-align:top; - line-height:.9em; -} - -pre.classic { - background-color:transparent; - border:none; - padding:0; -} - -p.img-caption { - margin: -0.5em 0 1em 1em; /* matches default img left-margin */ -} - -div.figure { - float:right; - clear:right; - margin:1em 0 0 3em; - padding:0; - background-color:#fff; - /* width must be defined w/ an inline style matching the image width */ -} - -#jd-content -div.figure img { - margin: 0 0 1em; -} - -div.figure p.img-caption { - margin: -0.5em 0 1em 0; -} - -p.table-caption { - margin: 0 0 0.5em 1em; /* matches default table left-margin */ -} - -/* Begin sidebox sidebar element styles */ - -.sidebox-wrapper { - float:right; - clear:right; - width:310px; /* +35px padding */ - background-color:#fff; - margin:0; - padding:0 0 20px 35px; -} - -.sidebox { - border-left:1px solid #dee8f1; - background-color:#ffffee; - margin:0; - padding:8px 12px; - font-size:0.9em; - width:285px; /* +24px padding; +1px border */ -} - -.sidebox p { - margin-bottom: .25em; -} - -.sidebox ul { - padding: 0 0 0 1.5em; -} - -.sidebox li ul { - margin-top:0; - margin-bottom:.1em; -} - -.sidebox li { -padding:0 0 0 0em; -} - -#jd-content .sidebox h2, -#jd-content .sidebox h3, -#jd-content .sidebox h4, -#jd-content .sidebox h5 { - border:none; - font-size:1em; - margin:0; - padding:0 0 8px; - left:0; - z-index:0; -} - -.sidebox hr { - background-color:#ccc; - border:none; -} - -/* End sidebox sidebar element styles */ - -/* table of contents */ - -ol.toc { - margin: 0 0 1em 0; - padding: 0; - list-style: none; - font-size:95%; -} - -ol.toc li { - font-weight: bold; - margin: 0 0 .5em 1em; - padding: 0; -} - -ol.toc li p { - font-weight: normal; -} - -ol.toc li ol { - margin: 0; - padding: 0; -} - -ol.toc li li { - padding: 0; - margin: 0 0 0 1em; - font-weight: normal; - list-style: none; -} - -table ol.toc { - margin-left: 0; -} - -.columns td { - padding:0 5px; - border:none; -} - -/* link table */ -.jd-linktable { - margin: 0 0 1em; - border-bottom: 1px solid #888; -} -.jd-linktable th, -.jd-linktable td { - padding: 3px 5px; - vertical-align: top; - text-align: left; - border:none; -} -.jd-linktable tr { - background-color: #fff; -} -.jd-linktable td { - border-top: 1px solid #888; - background-color: inherit; -} -.jd-linktable td p { - padding: 0 0 5px; -} -.jd-linktable .jd-linkcol { -} -.jd-linktable .jd-descrcol { -} -.jd-linktable .jd-typecol { - text-align:right; - white-space: nowrap; -} -.jd-linktable .jd-valcol { -} -.jd-linktable .jd-commentrow { - border-top:none; - padding-left:25px; -} -.jd-deprecated-warning { - margin-top: 0; - margin-bottom: 10px; -} - -tr.alt-color { - background-color: #f6f6f6; -} - -/* expando trigger */ -#jd-content .jd-expando-trigger-img { - margin:0; -} - -/* jd-expando */ -.jd-inheritedlinks { - padding:0 0 0 13px -} - -/* SDK PAGE */ -table.download tr { - background-color:#d9d9d9; -} - -table.download tr.alt-color { - background-color:#ededed; -} - -table.download td, -table.download th { - border:2px solid #fff; - padding:10px 5px; -} - -table.download th { - background-color:#6d8293; - color:#fff; -} - -/* INLAY 180 COPY and 240PX EXTENSION */ -/* modified to 43px so that all browsers eliminate the package panel h-scroll */ -.g-tpl-240 .g-unit, -.g-unit .g-tpl-240 .g-unit, -.g-unit .g-unit .g-tpl-240 .g-unit { - display: block; - margin: 0 0 0 243px; - width: auto; - float: none; -} -.g-unit .g-unit .g-tpl-240 .g-first, -.g-unit .g-tpl-240 .g-first, -.g-tpl-240 .g-first { - display: block; - margin: 0; - width: 243px; - float: left; -} -/* 240px alt */ -.g-tpl-240-alt .g-unit, -.g-unit .g-tpl-240-alt .g-unit, -.g-unit .g-unit .g-tpl-240-alt .g-unit { - display: block; - margin: 0 243px 0 0; - width: auto; - float: none; -} -.g-unit .g-unit .g-tpl-240-alt .g-first, -.g-unit .g-tpl-240-alt .g-first, -.g-tpl-240-alt .g-first { - display: block; - margin: 0; - width: 243px; - float: right; -} - -/* 180px */ -.g-tpl-180 .g-unit, -.g-unit .g-tpl-180 .g-unit, -.g-unit .g-unit .g-tpl-180 .g-unit { - display: block; - margin: 0 0 0 180px; - width: auto; - float: none; -} -.g-unit .g-unit .g-tpl-180 .g-first, -.g-unit .g-tpl-180 .g-first, -.g-tpl-180 .g-first { - display: block; - margin: 0; - width: 180px; - float: left; -} -/* 180px alt */ -.g-tpl-180-alt .g-unit, -.g-unit .g-tpl-180-alt .g-unit, -.g-unit .g-unit .g-tpl-180-alt .g-unit { - display: block; - margin: 0 180px 0 0; - width: auto; - float: none; -} -.g-unit .g-unit .g-tpl-180-alt .g-first, -.g-unit .g-tpl-180-alt .g-first, -.g-tpl-180-alt .g-first { - display: block; - margin: 0; - width: 180px; - float: right; -} - - -/* JQUERY RESIZABLE STYLES */ -.ui-resizable { position: relative; } -.ui-resizable-handle { position: absolute; display: none; font-size: 0.1px; z-index:1; } -.ui-resizable .ui-resizable-handle { display: block; } -body .ui-resizable-disabled .ui-resizable-handle { display: none; } -body .ui-resizable-autohide .ui-resizable-handle { display: none; } -.ui-resizable-s { cursor: s-resize; height: 6px; width: 100%; bottom: 0px; left: 0px; - background: transparent url("images/resizable-s2.gif") repeat scroll center top; } -.ui-resizable-e { cursor: e-resize; width: 6px; right: 0px; top: 0px; height: 100%; - background: transparent url("images/resizable-e2.gif") repeat scroll right center; } - -@media print { - - body { - overflow:visible; - } - - #header { - height:50px; - } - - #header-tabs, - #headerRight, - #side-nav, - #api-info-block { - display:none; - } - - #body-content { - position:inherit; - } - - #doc-content { - margin-left:0 !important; - height:auto !important; - width:auto !important; - overflow:inherit; - display:inline; - } - - #jd-header { - padding:10px 0; - } - - #jd-content { - padding:15px 0 0; - } - - #footer { - float:none; - margin:2em 0 0; - } - - h4.jd-details-title { - border-bottom:1px solid #666; - } - - pre { - /* these allow lines to break (if there's a white space) */ - overflow: visible; - text-wrap: unrestricted; - white-space: -moz-pre-wrap; /* Moz */ - white-space: -pre-wrap; /* Opera 4-6 */ - white-space: -o-pre-wrap; /* Opera 7 */ - white-space: pre-wrap; /* CSS3 */ - word-wrap: break-word; /* IE 5.5+ */ - } - - h1, h2, h3, h4, h5, h6 { - page-break-after: avoid; - } - - table, img { - page-break-inside: avoid; - } -} diff --git a/docs/apidocs/assets/doclava-developer-docs.js b/docs/apidocs/assets/doclava-developer-docs.js deleted file mode 100644 index 9429f90f..00000000 --- a/docs/apidocs/assets/doclava-developer-docs.js +++ /dev/null @@ -1,523 +0,0 @@ -var resizePackagesNav; -var classesNav; -var devdocNav; -var sidenav; -var content; -var HEADER_HEIGHT = -1; -var cookie_namespace = 'doclava_developer'; -var NAV_PREF_TREE = "tree"; -var NAV_PREF_PANELS = "panels"; -var nav_pref; -var toRoot; -var toAssets; -var isMobile = false; // true if mobile, so we can adjust some layout -var isIE6 = false; // true if IE6 - -// TODO: use $(document).ready instead -function addLoadEvent(newfun) { - var current = window.onload; - if (typeof window.onload != 'function') { - window.onload = newfun; - } else { - window.onload = function() { - current(); - newfun(); - } - } -} - -var agent = navigator['userAgent'].toLowerCase(); -// If a mobile phone, set flag and do mobile setup -if ((agent.indexOf("mobile") != -1) || // android, iphone, ipod - (agent.indexOf("blackberry") != -1) || - (agent.indexOf("webos") != -1) || - (agent.indexOf("mini") != -1)) { // opera mini browsers - isMobile = true; - addLoadEvent(mobileSetup); -// If not a mobile browser, set the onresize event for IE6, and others -} else if (agent.indexOf("msie 6") != -1) { - isIE6 = true; - addLoadEvent(function() { - window.onresize = resizeAll; - }); -} else { - addLoadEvent(function() { - window.onresize = resizeHeight; - }); -} - -function mobileSetup() { - $("body").css({'overflow':'auto'}); - $("html").css({'overflow':'auto'}); - $("#body-content").css({'position':'relative', 'top':'0'}); - $("#doc-content").css({'overflow':'visible', 'border-left':'3px solid #DDD'}); - $("#side-nav").css({'padding':'0'}); - $("#nav-tree").css({'overflow-y': 'auto'}); -} - -/* loads the lists.js file to the page. -Loading this in the head was slowing page load time */ -addLoadEvent( function() { - var lists = document.createElement("script"); - lists.setAttribute("type","text/javascript"); - lists.setAttribute("src", toRoot+"lists.js"); - document.getElementsByTagName("head")[0].appendChild(lists); -} ); - -addLoadEvent( function() { - $("pre:not(.no-pretty-print)").addClass("prettyprint"); - prettyPrint(); -} ); - -function setToRoot(root, assets) { - toRoot = root; - toAssets = assets; - // note: toRoot also used by carousel.js -} - -function restoreWidth(navWidth) { - var windowWidth = $(window).width() + "px"; - content.css({marginLeft:parseInt(navWidth) + 6 + "px"}); //account for 6px-wide handle-bar - - if (isIE6) { - content.css({width:parseInt(windowWidth) - parseInt(navWidth) - 6 + "px"}); // necessary in order for scrollbars to be visible - } - - sidenav.css({width:navWidth}); - resizePackagesNav.css({width:navWidth}); - classesNav.css({width:navWidth}); - $("#packages-nav").css({width:navWidth}); -} - -function restoreHeight(packageHeight) { - var windowHeight = ($(window).height() - HEADER_HEIGHT); - var swapperHeight = windowHeight - 13; - $("#swapper").css({height:swapperHeight + "px"}); - sidenav.css({height:windowHeight + "px"}); - content.css({height:windowHeight + "px"}); - resizePackagesNav.css({maxHeight:swapperHeight + "px", height:packageHeight}); - classesNav.css({height:swapperHeight - parseInt(packageHeight) + "px"}); - $("#packages-nav").css({height:parseInt(packageHeight) - 6 + "px"}); //move 6px to give space for the resize handle - devdocNav.css({height:sidenav.css("height")}); - $("#nav-tree").css({height:swapperHeight + "px"}); -} - -function readCookie(cookie) { - var myCookie = cookie_namespace+"_"+cookie+"="; - if (document.cookie) { - var index = document.cookie.indexOf(myCookie); - if (index != -1) { - var valStart = index + myCookie.length; - var valEnd = document.cookie.indexOf(";", valStart); - if (valEnd == -1) { - valEnd = document.cookie.length; - } - var val = document.cookie.substring(valStart, valEnd); - return val; - } - } - return 0; -} - -function writeCookie(cookie, val, section, expiration) { - if (val==undefined) return; - section = section == null ? "_" : "_"+section+"_"; - if (expiration == null) { - var date = new Date(); - date.setTime(date.getTime()+(10*365*24*60*60*1000)); // default expiration is one week - expiration = date.toGMTString(); - } - document.cookie = cookie_namespace + section + cookie + "=" + val + "; expires=" + expiration+"; path=/"; -} - -function getSection() { - if (location.href.indexOf("/reference/") != -1) { - return "reference"; - } else if (location.href.indexOf("/guide/") != -1) { - return "guide"; - } else if (location.href.indexOf("/resources/") != -1) { - return "resources"; - } - var basePath = getBaseUri(location.pathname); - return basePath.substring(1,basePath.indexOf("/",1)); -} - -function init() { - HEADER_HEIGHT = $("#header").height()+3; - $("#side-nav").css({position:"absolute",left:0}); - content = $("#doc-content"); - resizePackagesNav = $("#resize-packages-nav"); - classesNav = $("#classes-nav"); - sidenav = $("#side-nav"); - devdocNav = $("#devdoc-nav"); - - var cookiePath = getSection() + "_"; - - if (!isMobile) { - $("#resize-packages-nav").resizable({handles: "s", resize: function(e, ui) { resizePackagesHeight(); } }); - $(".side-nav-resizable").resizable({handles: "e", resize: function(e, ui) { resizeWidth(); } }); - var cookieWidth = readCookie(cookiePath+'width'); - var cookieHeight = readCookie(cookiePath+'height'); - if (cookieWidth) { - restoreWidth(cookieWidth); - } else if ($(".side-nav-resizable").length) { - resizeWidth(); - } - if (cookieHeight) { - restoreHeight(cookieHeight); - } else { - resizeHeight(); - } - } - - if (devdocNav.length) { // only dev guide, resources, and sdk - tryPopulateResourcesNav(); - highlightNav(location.href); - } -} - -function highlightNav(fullPageName) { - var lastSlashPos = fullPageName.lastIndexOf("/"); - var firstSlashPos; - if (fullPageName.indexOf("/guide/") != -1) { - firstSlashPos = fullPageName.indexOf("/guide/"); - } else if (fullPageName.indexOf("/sdk/") != -1) { - firstSlashPos = fullPageName.indexOf("/sdk/"); - } else { - firstSlashPos = fullPageName.indexOf("/resources/"); - } - if (lastSlashPos == (fullPageName.length - 1)) { // if the url ends in slash (add 'index.html') - fullPageName = fullPageName + "index.html"; - } - // First check if the exact URL, with query string and all, is in the navigation menu - var pathPageName = fullPageName.substr(firstSlashPos); - var link = $("#devdoc-nav a[href$='"+ pathPageName+"']"); - if (link.length == 0) { - var htmlPos = fullPageName.lastIndexOf(".html", fullPageName.length); - pathPageName = fullPageName.slice(firstSlashPos, htmlPos + 5); // +5 advances past ".html" - link = $("#devdoc-nav a[href$='"+ pathPageName+"']"); - if ((link.length == 0) && ((fullPageName.indexOf("/guide/") != -1) || (fullPageName.indexOf("/resources/") != -1))) { - // if there's no match, then let's backstep through the directory until we find an index.html page - // that matches our ancestor directories (only for dev guide and resources) - lastBackstep = pathPageName.lastIndexOf("/"); - while (link.length == 0) { - backstepDirectory = pathPageName.lastIndexOf("/", lastBackstep); - link = $("#devdoc-nav a[href$='"+ pathPageName.slice(0, backstepDirectory + 1)+"index.html']"); - lastBackstep = pathPageName.lastIndexOf("/", lastBackstep - 1); - if (lastBackstep == 0) break; - } - } - } - - // add 'selected' to the
  • or
  • ) and the parent
      is hidden - else if (link.parent().parent().is(':hidden')) { - toggle(link.parent().parent().parent(), false); // open the parent list - // then also check if the parent list is also nested in a hidden list - if (link.parent().parent().parent().parent().is(':hidden')) { - toggle(link.parent().parent().parent().parent().parent(), false); // open the super parent list - } - } -} - -/* Resize the height of the nav panels in the reference, - * and save the new size to a cookie */ -function resizePackagesHeight() { - var windowHeight = ($(window).height() - HEADER_HEIGHT); - var swapperHeight = windowHeight - 13; // move 13px for swapper link at the bottom - resizePackagesNav.css({maxHeight:swapperHeight + "px"}); - classesNav.css({height:swapperHeight - parseInt(resizePackagesNav.css("height")) + "px"}); - - $("#swapper").css({height:swapperHeight + "px"}); - $("#packages-nav").css({height:parseInt(resizePackagesNav.css("height")) - 6 + "px"}); //move 6px for handle - - var section = getSection(); - writeCookie("height", resizePackagesNav.css("height"), section, null); -} - -/* Resize the height of the side-nav and doc-content divs, - * which creates the frame effect */ -function resizeHeight() { - var docContent = $("#doc-content"); - - // Get the window height and always resize the doc-content and side-nav divs - var windowHeight = ($(window).height() - HEADER_HEIGHT); - docContent.css({height:windowHeight + "px"}); - $("#side-nav").css({height:windowHeight + "px"}); - - var href = location.href; - // If in the reference docs, also resize the "swapper", "classes-nav", and "nav-tree" divs - if (href.indexOf("/reference/") != -1) { - var swapperHeight = windowHeight - 13; - $("#swapper").css({height:swapperHeight + "px"}); - $("#classes-nav").css({height:swapperHeight - parseInt(resizePackagesNav.css("height")) + "px"}); - $("#nav-tree").css({height:swapperHeight + "px"}); - - // If in the dev guide docs, also resize the "devdoc-nav" div - } else if (href.indexOf("/guide/") != -1) { - $("#devdoc-nav").css({height:sidenav.css("height")}); - } else if (href.indexOf("/resources/") != -1) { - $("#devdoc-nav").css({height:sidenav.css("height")}); - } - - // Hide the "Go to top" link if there's no vertical scroll - if ( parseInt($("#jd-content").css("height")) <= parseInt(docContent.css("height")) ) { - $("a[href='#top']").css({'display':'none'}); - } else { - $("a[href='#top']").css({'display':'inline'}); - } -} - -/* Resize the width of the "side-nav" and the left margin of the "doc-content" div, - * which creates the resizable side bar */ -function resizeWidth() { - var windowWidth = $(window).width() + "px"; - if (sidenav.length) { - var sidenavWidth = sidenav.css("width"); - } else { - var sidenavWidth = 0; - } - content.css({marginLeft:parseInt(sidenavWidth) + 6 + "px"}); //account for 6px-wide handle-bar - - if (isIE6) { - content.css({width:parseInt(windowWidth) - parseInt(sidenavWidth) - 6 + "px"}); // necessary in order to for scrollbars to be visible - } - - resizePackagesNav.css({width:sidenavWidth}); - classesNav.css({width:sidenavWidth}); - $("#packages-nav").css({width:sidenavWidth}); - - if ($(".side-nav-resizable").length) { // Must check if the nav is resizable because IE6 calls resizeWidth() from resizeAll() for all pages - var section = getSection(); - writeCookie("width", sidenavWidth, section, null); - } -} - -/* For IE6 only, - * because it can't properly perform auto width for "doc-content" div, - * avoiding this for all browsers provides better performance */ -function resizeAll() { - resizeHeight(); - resizeWidth(); -} - -function getBaseUri(uri) { - var intlUrl = (uri.substring(0,6) == "/intl/"); - if (intlUrl) { - base = uri.substring(uri.indexOf('intl/')+5,uri.length); - base = base.substring(base.indexOf('/')+1, base.length); - //alert("intl, returning base url: /" + base); - return ("/" + base); - } else { - //alert("not intl, returning uri as found."); - return uri; - } -} - -function requestAppendHL(uri) { -//append "?hl= to an outgoing request (such as to blog) - var lang = getLangPref(); - if (lang) { - var q = 'hl=' + lang; - uri += '?' + q; - window.location = uri; - return false; - } else { - return true; - } -} - -function loadLast(cookiePath) { - var location = window.location.href; - if (location.indexOf("/"+cookiePath+"/") != -1) { - return true; - } - var lastPage = readCookie(cookiePath + "_lastpage"); - if (lastPage) { - window.location = lastPage; - return false; - } - return true; -} - -$(window).unload(function(){ - var path = getBaseUri(location.pathname); - if (path.indexOf("/reference/") != -1) { - writeCookie("lastpage", path, "reference", null); - } else if (path.indexOf("/guide/") != -1) { - writeCookie("lastpage", path, "guide", null); - } else if (path.indexOf("/resources/") != -1) { - writeCookie("lastpage", path, "resources", null); - } -}); - -function toggle(obj, slide) { - var ul = $("ul:first", obj); - var li = ul.parent(); - if (li.hasClass("closed")) { - if (slide) { - ul.slideDown("fast"); - } else { - ul.show(); - } - li.removeClass("closed"); - li.addClass("open"); - $(".toggle-img", li).attr("title", "hide pages"); - } else { - ul.slideUp("fast"); - li.removeClass("open"); - li.addClass("closed"); - $(".toggle-img", li).attr("title", "show pages"); - } -} - -function buildToggleLists() { - $(".toggle-list").each( - function(i) { - $("div:first", this).append(""); - $(this).addClass("closed"); - }); -} - -function getNavPref() { - var v = readCookie('reference_nav'); - if (v != NAV_PREF_TREE) { - v = NAV_PREF_PANELS; - } - return v; -} - -function chooseDefaultNav() { - nav_pref = getNavPref(); - if (nav_pref == NAV_PREF_TREE) { - $("#nav-panels").toggle(); - $("#panel-link").toggle(); - $("#nav-tree").toggle(); - $("#tree-link").toggle(); - } -} - -function swapNav() { - if (nav_pref == NAV_PREF_TREE) { - nav_pref = NAV_PREF_PANELS; - } else { - nav_pref = NAV_PREF_TREE; - init_default_navtree(toRoot); - } - var date = new Date(); - date.setTime(date.getTime()+(10*365*24*60*60*1000)); // keep this for 10 years - writeCookie("nav", nav_pref, "reference", date.toGMTString()); - - $("#nav-panels").toggle(); - $("#panel-link").toggle(); - $("#nav-tree").toggle(); - $("#tree-link").toggle(); - - if ($("#nav-tree").is(':visible')) scrollIntoView("nav-tree"); - else { - scrollIntoView("packages-nav"); - scrollIntoView("classes-nav"); - } -} - -function scrollIntoView(nav) { - var navObj = $("#"+nav); - if (navObj.is(':visible')) { - var selected = $(".selected", navObj); - if (selected.length == 0) return; - if (selected.is("div")) selected = selected.parent(); - - var scrolling = document.getElementById(nav); - var navHeight = navObj.height(); - var offsetTop = selected.position().top; - if (selected.parent().parent().is(".toggle-list")) offsetTop += selected.parent().parent().position().top; - if(offsetTop > navHeight - 92) { - scrolling.scrollTop = offsetTop - navHeight + 92; - } - } -} - -function changeTabLang(lang) { - var nodes = $("#header-tabs").find("."+lang); - for (i=0; i < nodes.length; i++) { // for each node in this language - var node = $(nodes[i]); - node.siblings().css("display","none"); // hide all siblings - if (node.not(":empty").length != 0) { //if this languages node has a translation, show it - node.css("display","inline"); - } else { //otherwise, show English instead - node.css("display","none"); - node.siblings().filter(".en").css("display","inline"); - } - } -} - -function changeNavLang(lang) { - var nodes = $("#side-nav").find("."+lang); - for (i=0; i < nodes.length; i++) { // for each node in this language - var node = $(nodes[i]); - node.siblings().css("display","none"); // hide all siblings - if (node.not(":empty").length != 0) { // if this languages node has a translation, show it - node.css("display","inline"); - } else { // otherwise, show English instead - node.css("display","none"); - node.siblings().filter(".en").css("display","inline"); - } - } -} - -function changeDocLang(lang) { - changeTabLang(lang); - changeNavLang(lang); -} - -function changeLangPref(lang, refresh) { - var date = new Date(); - expires = date.toGMTString(date.setTime(date.getTime()+(10*365*24*60*60*1000))); // keep this for 50 years - //alert("expires: " + expires) - writeCookie("pref_lang", lang, null, expires); - //changeDocLang(lang); - if (refresh) { - l = getBaseUri(location.pathname); - window.location = l; - } -} - -function loadLangPref() { - var lang = readCookie("pref_lang"); - if (lang != 0) { - $("#language").find("option[value='"+lang+"']").attr("selected",true); - } -} - -function getLangPref() { - var lang = $("#language").find(":selected").attr("value"); - if (!lang) { - lang = readCookie("pref_lang"); - } - return (lang != 0) ? lang : 'en'; -} - - -function toggleContent(obj) { - var button = $(obj); - var div = $(obj.parentNode); - var toggleMe = $(".toggle-content-toggleme",div); - if (button.hasClass("show")) { - toggleMe.slideDown(); - button.removeClass("show").addClass("hide"); - } else { - toggleMe.slideUp(); - button.removeClass("hide").addClass("show"); - } - $("span", button).toggle(); -} \ No newline at end of file diff --git a/docs/apidocs/assets/doclava-developer-reference.js b/docs/apidocs/assets/doclava-developer-reference.js deleted file mode 100644 index c854f01b..00000000 --- a/docs/apidocs/assets/doclava-developer-reference.js +++ /dev/null @@ -1,402 +0,0 @@ -var API_LEVEL_ENABLED_COOKIE = "api_level_enabled"; -var API_LEVEL_INDEX_COOKIE = "api_level_index"; -var minLevelIndex = 0; - -function toggleApiLevelSelector(checkbox) { - var date = new Date(); - date.setTime(date.getTime()+(10*365*24*60*60*1000)); // keep this for 10 years - var expiration = date.toGMTString(); - if (checkbox.checked) { - $("#apiLevelSelector").removeAttr("disabled"); - $("#api-level-toggle label").removeClass("disabled"); - writeCookie(API_LEVEL_ENABLED_COOKIE, 1, null, expiration); - } else { - $("#apiLevelSelector").attr("disabled","disabled"); - $("#api-level-toggle label").addClass("disabled"); - writeCookie(API_LEVEL_ENABLED_COOKIE, 0, null, expiration); - } - changeApiLevel(); -} - -function buildApiLevelSelector() { - var userApiLevelEnabled = readCookie(API_LEVEL_ENABLED_COOKIE); - var userApiLevelIndex = readCookie(API_LEVEL_INDEX_COOKIE); // No cookie (zero) is the same as maxLevel. - - if (userApiLevelEnabled == 0) { - $("#apiLevelSelector").attr("disabled","disabled"); - } else { - $("#apiLevelCheckbox").attr("checked","checked"); - $("#api-level-toggle label").removeClass("disabled"); - } - - minLevelValue = $("body").attr("class"); - minLevelIndex = apiKeyToIndex(minLevelValue); - var select = $("#apiLevelSelector").html("").change(changeApiLevel); - for (var i = SINCE_DATA.length-1; i >= 0; i--) { - var option = $("