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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringIdentifies the add icon.static final StringIdentifies the calendar icon.static final StringIdentifies the clear icon.static final StringIdentifies the columns icon.static final StringIdentifies the copy icon.static final StringIdentifies the delete icon.static final StringIdentifies the dependencies icon.static final StringIdentifies the detail icon.static final StringIdentifies the down icon.static final StringIdentifies the edit icon.static final StringIdentifies the edit-panel icon.static final StringIdentifies the edit-text icon.static final StringIdentifies the export icon.static final StringIdentifies the filter icon.static final PropertyValue<String> Specifies the name of theFrameworkIconsimplementation class to use.static final PropertyValue<Integer> The default large icon size, note that this will affect the size of buttons Value type: Integer Default value: 20static final StringIdentifies the logo icon.static final StringIdentifies the print icon.static final StringIdentifies the refresh icon.static final StringIdentifies the search icon.static final StringIdentifies the settings icon.static final PropertyValue<Integer> The default small icon size, note that this will affect the size of buttons Value type: Integer Default value: 16static final StringIdentifies the summary icon.static final StringIdentifies the up icon.static final StringIdentifies the update icon. -
Method Summary
Modifier and TypeMethodDescriptionadd()calendar()clear()columns()copy()delete()detail()down()edit()editText()export()filter()Retrieves theControlIconassociated with the given identifier.static FrameworkIconsinstance()logo()print()voidAdds the given icon.refresh()search()settings()summary()up()update()
-
Field Details
-
SMALL_SIZE
The default small icon size, note that this will affect the size of buttons- Value type: Integer
- Default value: 16
-
LARGE_SIZE
The default large icon size, note that this will affect the size of buttons- Value type: Integer
- Default value: 20
-
IMPLEMENTATION
Specifies the name of theFrameworkIconsimplementation class to use. -
FILTER
-
SEARCH
-
ADD
-
DELETE
-
UPDATE
-
COPY
-
REFRESH
-
CLEAR
-
UP
-
DOWN
-
DETAIL
-
PRINT
-
EDIT
-
SUMMARY
-
EDIT_PANEL
-
DEPENDENCIES
-
SETTINGS
-
CALENDAR
-
EDIT_TEXT
-
COLUMNS
-
EXPORT
-
LOGO
-
-
Method Details
-
put
Adds the given icon. Retrieve an icon viaget(String).- Parameters:
identifier- the identifiersvgUrl- the icon svg resource url- Throws:
IllegalArgumentException- in case an icon has already been associated with the given identifier
-
get
Retrieves theControlIconassociated with the given identifier.- Parameters:
identifier- the identifier- Returns:
- the
ControlIconassociated with the given identifier - Throws:
IllegalArgumentException- in case no icon has been associated with the given identifier- See Also:
-
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
- Returns:
- a
FrameworkIconsimplementation of the type specified byIMPLEMENTATION. - Throws:
IllegalArgumentException- in case no such implementation is found
-