com.alee.examples.content
Interface Example

All Known Implementing Classes:

AccordionExample, AndroidButtonsExample, AndroidFieldsExample, AndroidLabelExample, AndroidPanelExample, AndroidTextAreaExample, AsyncTreesExample, AttachedTabbedPanesExample, AttachedToolbarsExample, BlocksTransitionExample, BorderPaintersExample, ButtonBreadcrumbsExample, ButtonPaintersExample, ButtonPopupExample, ButtonProgressOverlayExample, ButtonsExample, CalendarExample, CheckBoxExample, CheckBoxListExample, CheckBoxTreeExample, CollapsiblePanesExample, ColorChooserDialogExample, ColorChooserDialogExample, ColorChooserFieldExample, ColorChooserPanelExample, ComboBoxExample, ComplexExample, ConfirmOptionPaneExample, CurtainTransitionExample, CustomContentTooltipExample, CustomDelayedTooltipExample, CustomHotkeyTooltipExample, CustomIconedTooltipExample, CustomInstantTooltipExample, CustomizedButtonsExample, CustomizedPopOverExample, CustomMultiSideTooltipExample, CustomNotificationsExample, CustomOneTimeTooltipExample, CustomPaintersExample, DateFieldExample, DecoratedPanelExample, DefaultExample, DefaultMenuBarExample, DefaultToolbarExample, DesktopPaneExample, DetachedPopOverExample, DirectionalPopOverExample, DirectoryChooserExample, DocumentPaneExample, DoubleGroupedButtonsExample, DynamicMenuExample, EditableComboBoxExample, EditorPaneExample, ErrorOptionPaneExample, ExtendedConfirmOptionPaneExample, FadeTransitionExample, FieldComponentsExample, FieldsInputPromptExample, FileBreadcrumbsExample, FileChooserDialogExample, FileChooserFieldsExample, FileChoosersExample, FileDropExample, FilesListExample, FileTreesExample, FocusTrackingExample, FocusTrackingPanelsExample, FormattedTextFieldsExample, FuturicoButtonsExample, FuturicoFieldsExample, FuturicoLabelExample, FuturicoPanelExample, FuturicoTextAreaExample, FuturicoToolbarExample, GalleryExample, GradientColorChooserExample, GroupedButtonsExample, HorizontalProgressBarsExample, HorizontalSlidersExample, HorizontalSplitPaneExample, HotkeyLabelsExample, IconedBreadcrumbsExample, ImageProgressOverlayExample, InputOptionPaneExample, LabelBreadcrumbsExample, LabelOverlayExample, LabelsExample, LanguageExample, LinkLabelsExample, ListsExample, MemoryBarExample, MenuBarExample, MessageOptionPaneExample, ModalPopOverExample, MultilineLabelExample, NinePatchEditorExample, NinePatchPaintersExample, OptionPanesExample, PanelBreadcrumbsExample, PartialPanelsExample, PasswordFieldsExample, PathFieldExample, ProgressBreadcrumbsExample, ProgressDialogExample, RadioButtonExample, RandomTransitionExample, ResizeOverlayExample, ShadedLabelsExample, SimplePopOverExample, SimplePopupExample, SimpleScrollPaneExample, SlideTransitionExample, SpinnersExample, SplitButtonExample, StandaloneMenuBarExample, StaticTableExample, StatusBarExample, StepLabelsExample, StepProgressExample, StyledComboBoxExample, StyledTabbedPanesExample, SwingTooltipExample, SwitchExample, TabbedPanesExample, TableExample, TextAreaExample, TextAreaOverlayExample, TextFieldOverlayExample, TextFieldsExample, TextNotificationsExample, TextPaneExample, TextProgressOverlayExample, ToggleButtonBreadcrumbsExample, ToggleButtonsExample, ToolbarsExample, TreesExample, TristateCheckBoxExample, UndecoratedMenuBarExample, UndecoratedStatusBarExample, VerticalLabelsExample, VerticalProgressBarsExample, VerticalSlidersExample, VerticalSplitPaneExample, VerticalToolbarsExample, WebComponentPanelExample, WebDecoratedImageExample, WebDialogExample, WebFrameExample, WebImageDropExample, WebImageExample

public interface Example

This interface provides base methods for WebLaF demo example classes managed by ExampleManager.

Author:

Mikle Garin

Method Summary

void	doWhenPresentationFinished(java.lang.Runnable runnable) Sets a runnable that should be executed at the end of the presentation.
java.lang.String	getDescription() Returns short example description.
FeatureState	getFeatureState() Returns current state of the component development.
java.awt.Component	getPreview(WebLookAndFeelDemo owner) Returns preview component for this example.
java.util.List<java.lang.Object>	getResources() Returns list of resources used in example.
java.lang.String	getTitle() Returns example title.
boolean	isFillWidth() Returns whether the example component should fill all available width or not.
boolean	isPresentationAvailable() Returns whether live presentation is available for this example or not.
void	nextPresentationStep() Forces live presentation to proceed to next step.
void	startPresentation() Starts live presentation.
void	stopPresentation() Stops live presentation.

Method Detail

getTitle

java.lang.String getTitle()

Returns example title. It might be used in examples tree or list.

Returns:

example title

getDescription

java.lang.String getDescription()

Returns short example description. It might be used in some additional information fields.

Returns:

short example description

getResources

java.util.List<java.lang.Object> getResources()

Returns list of resources used in example. There might be anything - images, files, urls, classes or something else. ExampleManager might provide preview components for some of their types.

Returns:

list of resources used in example

isPresentationAvailable

boolean isPresentationAvailable()

Returns whether live presentation is available for this example or not. Live presentation should guide user through the example, displaying its possible usage ways.

Returns:

true if live presentation is available for this example, false otherwise

startPresentation

void startPresentation()

Starts live presentation.

nextPresentationStep

void nextPresentationStep()

Forces live presentation to proceed to next step.

stopPresentation

void stopPresentation()

Stops live presentation.

doWhenPresentationFinished

void doWhenPresentationFinished(java.lang.Runnable runnable)

Sets a runnable that should be executed at the end of the presentation. You might want to cleanup some variables or components here.

Parameters:

runnable - runnable

getFeatureState

FeatureState getFeatureState()

Returns current state of the component development.

Returns:

current state of the component development

isFillWidth

boolean isFillWidth()

Returns whether the example component should fill all available width or not.

Returns:

true if the example component should fill all available width, false otherwise

getPreview

java.awt.Component getPreview(WebLookAndFeelDemo owner)

Returns preview component for this example. There might be any possible component here, but make sure it fits the demo application.

Parameters:

owner - demo application main frame

Returns:

preview component