com.luciad.lucy.gui

LuciadLightspeedClass TLcyActionBarItemComparator

java.lang.Object

com.luciad.lucy.gui.TLcyActionBarItemComparator

All Implemented Interfaces:

Comparator<TLcyActionBarItem>

public class TLcyActionBarItemComparator
extends Object
implements Comparator<TLcyActionBarItem>

Comparator that allows to sort items within a single TLcyGroupDescriptor. Those items can be ILcdActions or ILcyActiveSettables, but also Components or sub-menus. Some predefined sort methods are to sort alphabetically, or to add the most recently inserted item at the top (useful for say a recent items list). All available predefined sort strategies are defined as constants in this class (e.g. ABC), the syntax is defined in lucy.cfg (above TLcyMain.menuBar.groupPriorities).

Field Summary

Fields

Modifier and Type	Field and Description
static String	ABC Name of the order that order items alphabetically.
static String	END Name of the order that puts new items always at the end.
static String	FIXED Name of the order that puts items as configured in the configuration file.
static String	START Name of the order that puts new items always at the start.
static String	SUB_MENUS_FIRST Name of the order that puts sub menu items before other items.
static String	SUB_MENUS_LAST Name of the order that puts sub menu items after other items.
static String	ZYX Name of the order that order items inverse alphabetically.

Constructor Summary

Constructors

Constructor and Description
TLcyActionBarItemComparator(String[] aGroupDescriptors) Creates a new TLcyActionBarItemComparator that parses the group descriptor names for sort orders.

Method Summary

Modifier and Type	Method and Description
int	compare(TLcyActionBarItem aO1, TLcyActionBarItem aO2)
protected Comparator<TLcyActionBarItem>	createComparator(String aSortOrderName) Creates a Comparator for the given sort order name.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Field Detail

ABC

public static final String ABC

Name of the order that order items alphabetically.

See Also:

Constant Field Values

ZYX

public static final String ZYX

Name of the order that order items inverse alphabetically.

See Also:

Constant Field Values

SUB_MENUS_LAST

public static final String SUB_MENUS_LAST

Name of the order that puts sub menu items after other items.

See Also:

Constant Field Values

SUB_MENUS_FIRST

public static final String SUB_MENUS_FIRST

Name of the order that puts sub menu items before other items.

See Also:

Constant Field Values

FIXED

public static final String FIXED

Name of the order that puts items as configured in the configuration file.

See Also:

Constant Field Values

END

public static final String END

Name of the order that puts new items always at the end. This is the default order.

See Also:

Constant Field Values

START

public static final String START

Name of the order that puts new items always at the start.

See Also:

Constant Field Values

Constructor Detail

TLcyActionBarItemComparator

public TLcyActionBarItemComparator(String[] aGroupDescriptors)

Creates a new TLcyActionBarItemComparator that parses the group descriptor names for sort orders. The syntax is defined in lucy.cfg (above TLcyMain.menuBar.groupPriorities).

Parameters:

aGroupDescriptors - The names for the group descriptors, including the sort orders.

Method Detail

createComparator

protected Comparator<TLcyActionBarItem> createComparator(String aSortOrderName)

Creates a Comparator for the given sort order name. Overwrite this method to support additional sort orders.

Parameters:

aSortOrderName - The name of the sort order.

Returns:

The Comparator for the given sort order name.

compare

public int compare(TLcyActionBarItem aO1,
                   TLcyActionBarItem aO2)

Specified by:

compare in interface Comparator<TLcyActionBarItem>