at.favre.lib.hood.interfaces

Interface HoodAPI

public interface HoodAPI

The main API for the lib. Responsible for creating Pages and PageEntry

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	HoodAPI.Extension Extension of the API to allow creation of Section and OnClickAction for PageEntry
static interface	HoodAPI.Factory

Method Summary

Modifier and Type	Method and Description
PageEntry<?>	createActionEntry(ButtonDefinition action) Single column action
PageEntry<?>	createActionEntry(ButtonDefinition actionLeft, ButtonDefinition actionRight) Two columns with 2 different actions in a row
PageEntry<?>	createHeaderEntry(java.lang.CharSequence header) Creates a header entry
PageEntry<?>	createHeaderEntry(java.lang.CharSequence header, boolean hideInLog) Creates a header entry
PageEntry<?>	createMessageEntry(java.lang.CharSequence message) Creates a simple, non-interactive text message
Pages	createPages(Config config) Creates a new Pages object that can be used to fill with Page
PageEntry<?>	createPropertyEntry(java.lang.CharSequence key, DynamicValue<java.lang.String> value) Creates Key-Value style page entry.
PageEntry<?>	createPropertyEntry(java.lang.CharSequence key, DynamicValue<java.lang.String> value, boolean multiLine) Creates Key-Value style page entry.
PageEntry<?>	createPropertyEntry(java.lang.CharSequence key, DynamicValue<java.lang.String> value, OnClickAction action, boolean multiLine) Creates Key-Value style page entry.
PageEntry<?>	createPropertyEntry(java.lang.CharSequence key, java.lang.String value) Creates Key-Value style page entry with a static value.
PageEntry<?>	createPropertyEntry(java.lang.CharSequence key, java.lang.String value, boolean multiLine) Creates Key-Value style page entry with a static value.
PageEntry<?>	createPropertyEntry(java.lang.CharSequence key, java.lang.String value, OnClickAction action, boolean multiLine) Creates Key-Value style page entry with a static value.
PageEntry<?>	createSpinnerEntry(SingleSelectListConfigAction action) Creates a single-select from list entry (ie. spinner or drop-down list)
PageEntry<?>	createSwitchEntry(BoolConfigAction action) Creates an interactive switch like entry

Method Detail

createPages

Pages createPages(Config config)

Creates a new Pages object that can be used to fill with Page

Parameters:

config - the config used to create the pages

Returns:

pages

createActionEntry

PageEntry<?> createActionEntry(ButtonDefinition action)

Single column action

Parameters:

action -

createActionEntry

PageEntry<?> createActionEntry(ButtonDefinition actionLeft,
                               ButtonDefinition actionRight)

Two columns with 2 different actions in a row

Parameters:

actionLeft -

actionRight -

createHeaderEntry

PageEntry<?> createHeaderEntry(java.lang.CharSequence header)

Creates a header entry

Parameters:

header - as shown in ui

createHeaderEntry

PageEntry<?> createHeaderEntry(java.lang.CharSequence header,
                               boolean hideInLog)

Creates a header entry

Parameters:

header - as shown in ui

hideInLog - will omit it in log

createMessageEntry

PageEntry<?> createMessageEntry(java.lang.CharSequence message)

Creates a simple, non-interactive text message

Parameters:

message - as shown in

createSwitchEntry

PageEntry<?> createSwitchEntry(BoolConfigAction action)

Creates an interactive switch like entry

Parameters:

action -

createSpinnerEntry

PageEntry<?> createSpinnerEntry(SingleSelectListConfigAction action)

Creates a single-select from list entry (ie. spinner or drop-down list)

Parameters:

action -

createPropertyEntry

PageEntry<?> createPropertyEntry(java.lang.CharSequence key,
                                 DynamicValue<java.lang.String> value,
                                 OnClickAction action,
                                 boolean multiLine)

Creates Key-Value style page entry.

Parameters:

key - as shown in ui

value - dynamic value (e.g. from SharedPreferences

action - used when clicked on

multiLine - if a different layout should be used for long values

createPropertyEntry

PageEntry<?> createPropertyEntry(java.lang.CharSequence key,
                                 DynamicValue<java.lang.String> value,
                                 boolean multiLine)

Creates Key-Value style page entry. Uses dialog as default click action.

Parameters:

key - as shown in ui

value - dynamic value (e.g. from SharedPreferences

multiLine - if a different layout should be used for long values

createPropertyEntry

PageEntry<?> createPropertyEntry(java.lang.CharSequence key,
                                 DynamicValue<java.lang.String> value)

Creates Key-Value style page entry. Uses dialog as default click action and is not multiline enabled.

Parameters:

key - as shown in ui

value - dynamic value (e.g. from SharedPreferences

createPropertyEntry

PageEntry<?> createPropertyEntry(java.lang.CharSequence key,
                                 java.lang.String value,
                                 OnClickAction action,
                                 boolean multiLine)

Creates Key-Value style page entry with a static value.

Parameters:

key - as shown in ui

value - static value

action - used when clicked on (see HoodAPI.Extension createOnClickAction*() methods

multiLine - if a different layout should be used for long values

createPropertyEntry

PageEntry<?> createPropertyEntry(java.lang.CharSequence key,
                                 java.lang.String value,
                                 boolean multiLine)

Creates Key-Value style page entry with a static value. Uses dialog as default click action.

Parameters:

key - as shown in ui

value - static value

multiLine - if a different layout should be used for long values

createPropertyEntry

PageEntry<?> createPropertyEntry(java.lang.CharSequence key,
                                 java.lang.String value)

Creates Key-Value style page entry with a static value. Uses dialog as default click action and ist not multi-line enabled.

Parameters:

key - as shown in ui

value - static value