Module is.codion.swing.framework.ui

Package is.codion.swing.framework.ui.icon

Interface FrameworkIcons

All Known Implementing Classes:

DefaultFrameworkIcons

public interface FrameworkIcons

Provides icons for framework ui components. The icon color follows the 'Button.foreground' color of the current Look and feel. Add custom icons via put(String, URL) and retrieve them via get(String).

See Also:

• instance()

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD	Identifies the add icon.
static final String	CALENDAR	Identifies the calendar icon.
static final String	CLEAR	Identifies the clear icon.
static final String	COLUMNS	Identifies the columns icon.
static final String	COPY	Identifies the copy icon.
static final String	DELETE	Identifies the delete icon.
static final String	DEPENDENCIES	Identifies the dependencies icon.
static final String	DETAIL	Identifies the detail icon.
static final String	DOWN	Identifies the down icon.
static final String	EDIT	Identifies the edit icon.
static final String	EDIT_PANEL	Identifies the edit-panel icon.
static final String	EDIT_TEXT	Identifies the edit-text icon.
static final String	EXPORT	Identifies the export icon.
static final String	FILTER	Identifies the filter icon.
static final PropertyValue<String>	FRAMEWORK_ICONS	Specifies the name of the FrameworkIcons implementation class to use.
static final PropertyValue<Integer>	LARGE_SIZE	The default large icon size, note that this will affect the size of buttons Value type: Integer Default value: 20
static final String	LOGO	Identifies the logo icon.
static final String	PRINT	Identifies the print icon.
static final String	REFRESH	Identifies the refresh icon.
static final String	SEARCH	Identifies the search icon.
static final String	SETTINGS	Identifies the settings icon.
static final PropertyValue<Integer>	SMALL_SIZE	The default small icon size, note that this will affect the size of buttons Value type: Integer Default value: 16
static final String	SUMMARY	Identifies the summary icon.
static final String	UP	Identifies the up icon.
static final String	UPDATE	Identifies the update icon.

Method Summary

Modifier and Type	Method	Description
ControlIcon	add()
ControlIcon	calendar()
ControlIcon	clear()
ControlIcon	clearSelection()
ControlIcon	columns()
ControlIcon	copy()
ControlIcon	delete()
ControlIcon	dependencies()
ControlIcon	detail()
ControlIcon	down()
ControlIcon	edit()
ControlIcon	editPanel()
ControlIcon	editText()
ControlIcon	export()
ControlIcon	filter()
ControlIcon	get(String identifier)	Retrieves the ControlIcon associated with the given identifier.
static FrameworkIcons	instance()
ControlIcon	logo()
ControlIcon	print()
void	put(String identifier, URL svgUrl)	Adds the given icon.
ControlIcon	refresh()
ControlIcon	search()
ControlIcon	settings()
ControlIcon	summary()
ControlIcon	up()
ControlIcon	update()

Field Details

SMALL_SIZE

static final PropertyValue<Integer> SMALL_SIZE

The default small icon size, note that this will affect the size of buttons

• Value type: Integer
• Default value: 16

LARGE_SIZE

static final PropertyValue<Integer> LARGE_SIZE

The default large icon size, note that this will affect the size of buttons

• Value type: Integer
• Default value: 20

FRAMEWORK_ICONS

static final PropertyValue<String> FRAMEWORK_ICONS

Specifies the name of the FrameworkIcons implementation class to use.

FILTER

static final String FILTER

Identifies the filter icon.

See Also:

• Constant Field Values

SEARCH

static final String SEARCH

Identifies the search icon.

See Also:

• Constant Field Values

ADD

static final String ADD

Identifies the add icon.

See Also:

• Constant Field Values

DELETE

static final String DELETE

Identifies the delete icon.

See Also:

• Constant Field Values

UPDATE

static final String UPDATE

Identifies the update icon.

See Also:

• Constant Field Values

COPY

static final String COPY

Identifies the copy icon.

See Also:

• Constant Field Values

REFRESH

static final String REFRESH

Identifies the refresh icon.

See Also:

• Constant Field Values

CLEAR

static final String CLEAR

Identifies the clear icon.

See Also:

• Constant Field Values

UP

static final String UP

Identifies the up icon.

See Also:

• Constant Field Values

DOWN

static final String DOWN

Identifies the down icon.

See Also:

• Constant Field Values

DETAIL

static final String DETAIL

Identifies the detail icon.

See Also:

• Constant Field Values

PRINT

static final String PRINT

Identifies the print icon.

See Also:

• Constant Field Values

EDIT

static final String EDIT

Identifies the edit icon.

See Also:

• Constant Field Values

SUMMARY

static final String SUMMARY

Identifies the summary icon.

See Also:

• Constant Field Values

EDIT_PANEL

static final String EDIT_PANEL

Identifies the edit-panel icon.

See Also:

• Constant Field Values

DEPENDENCIES

static final String DEPENDENCIES

Identifies the dependencies icon.

See Also:

• Constant Field Values

SETTINGS

static final String SETTINGS

Identifies the settings icon.

See Also:

• Constant Field Values

CALENDAR

static final String CALENDAR

Identifies the calendar icon.

See Also:

• Constant Field Values

EDIT_TEXT

static final String EDIT_TEXT

Identifies the edit-text icon.

See Also:

• Constant Field Values

COLUMNS

static final String COLUMNS

Identifies the columns icon.

See Also:

• Constant Field Values

EXPORT

static final String EXPORT

Identifies the export icon.

See Also:

• Constant Field Values

LOGO

static final String LOGO

Identifies the logo icon.

See Also:

• Constant Field Values

Method Details

put

void put(String identifier,
 URL svgUrl)

Adds the given icon. Retrieve an icon via get(String).

Parameters:

identifier - the identifier

svgUrl - the icon svg resource url

Throws:

IllegalArgumentException - in case an icon has already been associated with the given identifier

get

ControlIcon get(String identifier)

Retrieves the ControlIcon associated with the given identifier.

Parameters:

identifier - the identifier

Returns:

the ControlIcon associated with the given identifier

Throws:

IllegalArgumentException - in case no icon has been associated with the given identifier

See Also:

• put(String, URL)

filter

ControlIcon filter()

Returns:

icon for the 'filter' action.

search

ControlIcon search()

Returns:

icon for the 'search' action.

add

ControlIcon add()

Returns:

icon for the 'add' action.

delete

ControlIcon delete()

Returns:

icon for the 'delete' action.

update

ControlIcon update()

Returns:

icon for the 'update' action.

copy

ControlIcon copy()

Returns:

icon for the 'copy' action.

refresh

ControlIcon refresh()

Returns:

icon for the 'refresh' action.

clear

ControlIcon clear()

Returns:

icon for the 'clear' action.

up

ControlIcon up()

Returns:

icon for the 'up' action.

down

ControlIcon down()

Returns:

icon for the 'down' action.

detail

ControlIcon detail()

Returns:

icon for the 'detail' action.

print

ControlIcon print()

Returns:

icon for the 'print' action.

clearSelection

ControlIcon clearSelection()

Returns:

icon for the 'clear selection' action.

edit

ControlIcon edit()

Returns:

icon for the 'edit' action.

summary

ControlIcon summary()

Returns:

icon for the 'summary' action.

editPanel

ControlIcon editPanel()

Returns:

icon for the 'edit panel' action.

dependencies

ControlIcon dependencies()

Returns:

icon for the 'dependencies' action.

settings

ControlIcon settings()

Returns:

icon for a 'settings' action.

calendar

ControlIcon calendar()

Returns:

icon for a 'calendar' action

editText

ControlIcon editText()

Returns:

icon for a 'editText' action

columns

ControlIcon columns()

Returns:

icon for a 'columns' action

export

ControlIcon export()

Returns:

the export icon.

logo

ControlIcon logo()

Returns:

the logo icon.

instance

static FrameworkIcons instance()

Returns:

a FrameworkIcons implementation of the type specified by FRAMEWORK_ICONS.

Throws:

IllegalArgumentException - in case no such implementation is found