com.github.bordertech.wcomponents.examples.picker

Class ExampleData

java.lang.Object

com.github.bordertech.wcomponents.examples.picker.ExampleData

All Implemented Interfaces:

Serializable

public final class ExampleData
extends Object
implements Serializable

ExampleData contains the information necessary to describe an example. It also provides some groupings for the standard WComponent examples.

Since:

1.0.0

Author:

Yiannis Paschalidis

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static ExampleData[]	AJAX_EXAMPLES AJAX examples.
static ExampleData[]	FEEDBACK_AND_INDICATORS Examples showing (non-interactive) feedback and indicator controls.
static ExampleData[]	FORM_CONTROLS Examples showing (interactive) form controls.
static ExampleData[]	LAYOUT_EXAMPLES Layout examples.
static ExampleData[]	LINK_EXAMPLES WLink and similar linky examples.
static ExampleData[]	MENU_EXAMPLES Menu examples.
static ExampleData[]	MISC_EXAMPLES Other miscellaneous examples.
static ExampleData[]	POPUP_EXAMPLES Examples of pop-up windows, dialogs, etc.
static ExampleData[]	SUBORDINATE_EXAMPLES Subordinate control examples.
static ExampleData[]	TABSET_EXAMPLES Tabset examples.
static ExampleData[]	VALIDATION_EXAMPLES Validation examples.
static ExampleData[]	WDATATABLE_EXAMPLES WDataTable examples.
static ExampleData[]	WTABLE_EXAMPLES WTable examples.

Constructor Summary

Constructors

Constructor and Description
ExampleData() Creates an ExampleData.
ExampleData(String exampleName, Class<? extends WComponent> exampleClass) Creates an ExampleData.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Class<? extends WComponent>	getExampleClass()
String	getExampleGroupName() returns the group name of the example.
String	getExampleName()
int	hashCode()
void	setExampleClass(Class<? extends WComponent> exampleClass) setter for example class.
void	setExampleGroupName(String exampleGroupName) setter for the group name of the example.
void	setExampleName(String exampleName) setter for example name.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

AJAX_EXAMPLES

public static final ExampleData[] AJAX_EXAMPLES

AJAX examples.

FORM_CONTROLS

public static final ExampleData[] FORM_CONTROLS

Examples showing (interactive) form controls.

FEEDBACK_AND_INDICATORS

public static final ExampleData[] FEEDBACK_AND_INDICATORS

Examples showing (non-interactive) feedback and indicator controls.

WDATATABLE_EXAMPLES

public static final ExampleData[] WDATATABLE_EXAMPLES

WDataTable examples.

WTABLE_EXAMPLES

public static final ExampleData[] WTABLE_EXAMPLES

WTable examples.

MISC_EXAMPLES

public static final ExampleData[] MISC_EXAMPLES

Other miscellaneous examples.

SUBORDINATE_EXAMPLES

public static final ExampleData[] SUBORDINATE_EXAMPLES

Subordinate control examples.

LAYOUT_EXAMPLES

public static final ExampleData[] LAYOUT_EXAMPLES

Layout examples.

POPUP_EXAMPLES

public static final ExampleData[] POPUP_EXAMPLES

Examples of pop-up windows, dialogs, etc.

MENU_EXAMPLES

public static final ExampleData[] MENU_EXAMPLES

Menu examples.

TABSET_EXAMPLES

public static final ExampleData[] TABSET_EXAMPLES

Tabset examples.

VALIDATION_EXAMPLES

public static final ExampleData[] VALIDATION_EXAMPLES

Validation examples.

LINK_EXAMPLES

public static final ExampleData[] LINK_EXAMPLES

WLink and similar linky examples.

Constructor Detail

ExampleData

public ExampleData(String exampleName,
                   Class<? extends WComponent> exampleClass)

Creates an ExampleData.

Parameters:

exampleName - the short name / description of the example

exampleClass - the example class

ExampleData

public ExampleData()

Creates an ExampleData.

Method Detail

getExampleGroupName

public String getExampleGroupName()

returns the group name of the example.

Returns:

the group name.

setExampleGroupName

public void setExampleGroupName(String exampleGroupName)

setter for the group name of the example.

Parameters:

exampleGroupName - the group name.

getExampleName

public String getExampleName()

Returns:

Returns the short name / description of the example.

setExampleName

public void setExampleName(String exampleName)

setter for example name.

Parameters:

exampleName - the example name.

setExampleClass

public void setExampleClass(Class<? extends WComponent> exampleClass)

setter for example class.

Parameters:

exampleClass - the example class

getExampleClass

public Class<? extends WComponent> getExampleClass()

Returns:

Returns the example class.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object