Interactive Features of Code Sample Pages
Popup Annotations
Roll the mouse over blue underlines to reveal information relevant to the underlined text. Roll over vertical blue bars to reveal explanations about the corresponding block of code.
Javadoc Annotations
Roll the mouse over API elements to reveal their Javadocs. The Javadocs for the Java Development Kit APIs are available on all code samples and do not have a marker. Other code samples may have the Javadocs for additional libraries, depending on the focus of the sample. For instance, code samples focused on testing will include the Javadocs for JUnit.
Search Bar
Use our special Search Bar (Ctrl+Shift+F) to search within the entire annotated document, including through hidden annotations. Clicking on a resulting match will open the annotation that contains the selected match in a dialog.
Walkthrough
Click on the Walkthrough button to start a tour of the most important annotations for the code sample. Use the Prev and Next buttons to move through the sequence, and End to end it. Not all code samples have a walkthrough, and the walkthrough generally does not involve all available annotations for a sample.
Pinned Annotations
Clicking on an element associated with an annotation will pin the annotation, turning the popover into a dialog. Pinned annotations can be moved around and resized. They also contain additional information, such as links to external resources. Annotations revealed through the Search Bar or Walkthrough features are automatically pinned.
Links to Annotations
Pinned annotations are web resources that can be linked to. The URL to an annotation is available at the bottom of the pinned annotation, anchored to the text Link to this annotation.
Save Page State
Use the Save State button to save the state of a page with multiple pinned annotations as a Unified Resource Locator (URL). Accessing the URL will return to the code sample page with the same pinned annotations in the same locations as when state was saved.
Information Layers
You can customize what kind of information is available as annotations in the code sample by clicking the Layers button. Notes are explanations specifically about the code sample. Insights are general insights on software design that apply to the current code sample. Javadocs refers to the API reference documentation for the elements in the sample.
