com.alee.examples.content
Interface ExampleGroup

All Known Implementing Classes:

AndroidStylingGroup, BreadcrumbsGroup, ButtonsGroup, CheckBoxesGroup, CollapsiblePanesGroup, ColorChoosersGroup, ComboBoxesGroup, ComplexGroup, DateChoosersGroup, DefaultExampleGroup, DesktopPaneGroup, DocumentPaneGroup, DynamicMenuGroup, FieldsGroup, FileChoosersGroup, FocusTrackingGroup, FuturicoStylingGroup, GalleryGroup, ImagesGroup, LabelsGroup, LanguageGroup, ListsGroup, MenuBarsGroup, NinePatchEditorGroup, NotificationsGroup, OptionPanesGroup, OverlayGroup, PaintersGroup, PanelsGroup, PopOverGroup, PopupsGroup, ProgressBarsGroup, ProgressGroup, ScrollPaneGroup, SlidersGroup, SplitPanesGroup, StatusBarsGroup, TabbedPanesGroup, TablesGroup, TextAreasGroup, ToolbarsGroup, TooltipsGroup, TransitionsGroup, TreesGroup, WindowsGroup

public interface ExampleGroup

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

Author:

Mikle Garin

Method Summary

double	getContentPartSize() Returns examples content side width relative to the whole available to example group width.
FeatureState	getFeatureGroupState() Returns an enumeration constant that represents average development state of example components in the group.
java.lang.String	getGroupDescription() Returns short example group description.
java.util.List<Example>	getGroupExamples() Returns a list of examples for this example group.
javax.swing.Icon	getGroupIcon() Returns example group icon.
java.lang.String	getGroupName() Returns example group name.
java.awt.Color	getPreferredForeground() Returns preferred foreground color for example group demo page.
boolean	isShowWatermark() Returns whether this example group should display a watermark in demo application or not.
boolean	isSingleExample() Returns whether this example group contains only one example or not.
void	modifyExampleTab(int tabIndex, WebTabbedPane tabbedPane) Method provided to modify example group tab.
WebSeparator	modifySeparator(WebSeparator separator) Method provided to modify examples separator.

Method Detail

getGroupIcon

javax.swing.Icon getGroupIcon()

Returns example group icon.

Returns:

example group icon

getGroupName

java.lang.String getGroupName()

Returns example group name.

Returns:

example group name

getGroupDescription

java.lang.String getGroupDescription()

Returns short example group description.

Returns:

short example group description

isSingleExample

boolean isSingleExample()

Returns whether this example group contains only one example or not.

Returns:

true if this example group contains only one example, false otherwise

isShowWatermark

boolean isShowWatermark()

Returns whether this example group should display a watermark in demo application or not.

Returns:

true if this example group should display a watermark in demo application, false otherwise

getFeatureGroupState

FeatureState getFeatureGroupState()

Returns an enumeration constant that represents average development state of example components in the group.

Returns:

average development state of example components in the group

getGroupExamples

java.util.List<Example> getGroupExamples()

Returns a list of examples for this example group.

Returns:

list of examples

modifyExampleTab

void modifyExampleTab(int tabIndex,
                      WebTabbedPane tabbedPane)

Method provided to modify example group tab.

Parameters:

tabIndex - index of example group tab

tabbedPane - tabbed pane that contains example group tab

modifySeparator

WebSeparator modifySeparator(WebSeparator separator)

Method provided to modify examples separator.

Parameters:

separator - examples separator

Returns:

modified examples separator

getPreferredForeground

java.awt.Color getPreferredForeground()

Returns preferred foreground color for example group demo page.

Returns:

preferred foreground color for example group demo page

getContentPartSize

double getContentPartSize()

Returns examples content side width relative to the whole available to example group width.

Returns:

examples content side width relative to the whole available to example group width