Package org.teamapps.ux.component.template

Enum Class BaseTemplate

java.lang.Object

java.lang.Enum<BaseTemplate>

org.teamapps.ux.component.template.BaseTemplate

All Implemented Interfaces:

Serializable, Comparable<BaseTemplate>, Constable, Template

public enum BaseTemplate
extends Enum<BaseTemplate>
implements Template

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
APPLICATION_LISTING
BUTTON
BUTTON_LARGE
BUTTON_XLARGE
FILE_ITEM_FLOATING
FILE_ITEM_LIST
FORM_SECTION_HEADER
ITEM_VIEW_ITEM
LIST_ITEM_EXTRA_VERY_LARGE_ICON_TWO_LINES
LIST_ITEM_LARGE_ICON_SINGLE_LINE
LIST_ITEM_LARGE_ICON_TWO_LINES
LIST_ITEM_MEDIUM_ICON_SINGLE_LINE
LIST_ITEM_MEDIUM_ICON_TWO_LINES
LIST_ITEM_SMALL_ICON_SINGLE_LINE
LIST_ITEM_VERY_LARGE_ICON_TWO_LINES
MENU_ITEM
NAVIGATION_BAR_ICON_ONLY
NOTIFICATION_ICON_CAPTION
NOTIFICATION_ICON_CAPTION_DESCRIPTION
TOOL_BUTTON
TOOLBAR_BUTTON
TOOLBAR_BUTTON_SMALL
TOOLBAR_BUTTON_TINY
TOOLBAR_MENU_BIG_BUTTON
TOOLBAR_MENU_GROUP_HEADER

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_ARIA_LABEL
static final String	PROPERTY_BADGE
static final String	PROPERTY_CAPTION
static final String	PROPERTY_CAPTION_ICON
static final String	PROPERTY_DESCRIPTION
static final String	PROPERTY_ICON
static final String	PROPERTY_ID
static final String	PROPERTY_IMAGE
static final String	PROPERTY_RIGHT_ICON
static final String	PROPERTY_SUB_ICON1
static final String	PROPERTY_SUB_ICON2
static final String	PROPERTY_SUB_TEXT1
static final String	PROPERTY_SUB_TEXT2
static final String	PROPERTY_TITLE

Method Summary

Modifier and Type	Method	Description
static Template	createFormButtonTemplate(int iconSize, float relativeFontSize)
static Template	createListStyleIconTwoLinesBadgeTemplate(int iconSize, VerticalElementAlignment verticalIconAlignment, int maxHeight, int spacing)
static Template	createListStyleIconTwoLinesBadgeTemplate(int iconSize, VerticalElementAlignment verticalIconAlignment, int maxHeight, int spacing, boolean wrapLines)
static GridTemplate	createTemplate(int minWidth, int maxWidth, int minHeight, int maxHeight, Spacing padding, int gridGap, boolean horizontalCenterAlignment, int mainIconSize, boolean mainIconAlignTop, org.teamapps.common.format.Color mainImageBorderColor, int captionIconSize, float captionSize, org.teamapps.common.format.Color captionColor, boolean wrapCaption, float badgeSize, org.teamapps.common.format.Color badgeTextColor, org.teamapps.common.format.Color badgeBackgroundColor, int rightIconSize, int subIcon1Size, float subText1Size, org.teamapps.common.format.Color subText1Color, int subIcon2Size, float subText2Size, org.teamapps.common.format.Color subText2Color, float descriptionTextSize, org.teamapps.common.format.Color descriptionTextColor)
static Map<String,Template>	createTemplateMap(BaseTemplate... templates)
static Template	createTreeSingleLineNodeTemplate(int iconSize, VerticalElementAlignment verticalIconAlignment, int maxHeight)
static Template	createTreeSingleLineNodeTemplate(int iconSize, VerticalElementAlignment verticalIconAlignment, int maxHeight, boolean wrapLines)
org.teamapps.dto.UiTemplate	createUiTemplate()
List<String>	getPropertyNames()
Template	getTemplate()
static BaseTemplate	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BaseTemplate[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.teamapps.ux.component.template.Template

createDarkThemeTemplate

Enum Constant Details

TOOL_BUTTON

public static final BaseTemplate TOOL_BUTTON

TOOLBAR_BUTTON

public static final BaseTemplate TOOLBAR_BUTTON

TOOLBAR_BUTTON_SMALL

public static final BaseTemplate TOOLBAR_BUTTON_SMALL

TOOLBAR_BUTTON_TINY

public static final BaseTemplate TOOLBAR_BUTTON_TINY

TOOLBAR_MENU_GROUP_HEADER

public static final BaseTemplate TOOLBAR_MENU_GROUP_HEADER

TOOLBAR_MENU_BIG_BUTTON

public static final BaseTemplate TOOLBAR_MENU_BIG_BUTTON

ITEM_VIEW_ITEM

public static final BaseTemplate ITEM_VIEW_ITEM

APPLICATION_LISTING

public static final BaseTemplate APPLICATION_LISTING

FILE_ITEM_FLOATING

public static final BaseTemplate FILE_ITEM_FLOATING

FILE_ITEM_LIST

public static final BaseTemplate FILE_ITEM_LIST

LIST_ITEM_SMALL_ICON_SINGLE_LINE

public static final BaseTemplate LIST_ITEM_SMALL_ICON_SINGLE_LINE

LIST_ITEM_MEDIUM_ICON_SINGLE_LINE

public static final BaseTemplate LIST_ITEM_MEDIUM_ICON_SINGLE_LINE

LIST_ITEM_LARGE_ICON_SINGLE_LINE

public static final BaseTemplate LIST_ITEM_LARGE_ICON_SINGLE_LINE

LIST_ITEM_EXTRA_VERY_LARGE_ICON_TWO_LINES

public static final BaseTemplate LIST_ITEM_EXTRA_VERY_LARGE_ICON_TWO_LINES

LIST_ITEM_VERY_LARGE_ICON_TWO_LINES

public static final BaseTemplate LIST_ITEM_VERY_LARGE_ICON_TWO_LINES

LIST_ITEM_LARGE_ICON_TWO_LINES

public static final BaseTemplate LIST_ITEM_LARGE_ICON_TWO_LINES

LIST_ITEM_MEDIUM_ICON_TWO_LINES

public static final BaseTemplate LIST_ITEM_MEDIUM_ICON_TWO_LINES

MENU_ITEM

public static final BaseTemplate MENU_ITEM

FORM_SECTION_HEADER

public static final BaseTemplate FORM_SECTION_HEADER

BUTTON

public static final BaseTemplate BUTTON

BUTTON_LARGE

public static final BaseTemplate BUTTON_LARGE

BUTTON_XLARGE

public static final BaseTemplate BUTTON_XLARGE

NOTIFICATION_ICON_CAPTION

public static final BaseTemplate NOTIFICATION_ICON_CAPTION

NOTIFICATION_ICON_CAPTION_DESCRIPTION

public static final BaseTemplate NOTIFICATION_ICON_CAPTION_DESCRIPTION

NAVIGATION_BAR_ICON_ONLY

public static final BaseTemplate NAVIGATION_BAR_ICON_ONLY

Field Details

PROPERTY_ID

public static final String PROPERTY_ID

See Also:

• Constant Field Values

PROPERTY_ICON

public static final String PROPERTY_ICON

See Also:

• Constant Field Values

PROPERTY_IMAGE

public static final String PROPERTY_IMAGE

See Also:

• Constant Field Values

PROPERTY_CAPTION

public static final String PROPERTY_CAPTION

See Also:

• Constant Field Values

PROPERTY_DESCRIPTION

public static final String PROPERTY_DESCRIPTION

See Also:

• Constant Field Values

PROPERTY_BADGE

public static final String PROPERTY_BADGE

See Also:

• Constant Field Values

PROPERTY_CAPTION_ICON

public static final String PROPERTY_CAPTION_ICON

See Also:

• Constant Field Values

PROPERTY_RIGHT_ICON

public static final String PROPERTY_RIGHT_ICON

See Also:

• Constant Field Values

PROPERTY_SUB_TEXT1

public static final String PROPERTY_SUB_TEXT1

See Also:

• Constant Field Values

PROPERTY_SUB_TEXT2

public static final String PROPERTY_SUB_TEXT2

See Also:

• Constant Field Values

PROPERTY_SUB_ICON1

public static final String PROPERTY_SUB_ICON1

See Also:

• Constant Field Values

PROPERTY_SUB_ICON2

public static final String PROPERTY_SUB_ICON2

See Also:

• Constant Field Values

PROPERTY_ARIA_LABEL

public static final String PROPERTY_ARIA_LABEL

See Also:

• Constant Field Values

PROPERTY_TITLE

public static final String PROPERTY_TITLE

See Also:

• Constant Field Values

Method Details

values

public static BaseTemplate[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static BaseTemplate valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

createTemplateMap

public static Map<String,Template> createTemplateMap(BaseTemplate... templates)

createListStyleIconTwoLinesBadgeTemplate

public static Template createListStyleIconTwoLinesBadgeTemplate(int iconSize,
 VerticalElementAlignment verticalIconAlignment,
 int maxHeight,
 int spacing)

createListStyleIconTwoLinesBadgeTemplate

public static Template createListStyleIconTwoLinesBadgeTemplate(int iconSize,
 VerticalElementAlignment verticalIconAlignment,
 int maxHeight,
 int spacing,
 boolean wrapLines)

createTemplate

public static GridTemplate createTemplate(int minWidth,
 int maxWidth,
 int minHeight,
 int maxHeight,
 Spacing padding,
 int gridGap,
 boolean horizontalCenterAlignment,
 int mainIconSize,
 boolean mainIconAlignTop,
 org.teamapps.common.format.Color mainImageBorderColor,
 int captionIconSize,
 float captionSize,
 org.teamapps.common.format.Color captionColor,
 boolean wrapCaption,
 float badgeSize,
 org.teamapps.common.format.Color badgeTextColor,
 org.teamapps.common.format.Color badgeBackgroundColor,
 int rightIconSize,
 int subIcon1Size,
 float subText1Size,
 org.teamapps.common.format.Color subText1Color,
 int subIcon2Size,
 float subText2Size,
 org.teamapps.common.format.Color subText2Color,
 float descriptionTextSize,
 org.teamapps.common.format.Color descriptionTextColor)

createTreeSingleLineNodeTemplate

public static Template createTreeSingleLineNodeTemplate(int iconSize,
 VerticalElementAlignment verticalIconAlignment,
 int maxHeight)

createTreeSingleLineNodeTemplate

public static Template createTreeSingleLineNodeTemplate(int iconSize,
 VerticalElementAlignment verticalIconAlignment,
 int maxHeight,
 boolean wrapLines)

createFormButtonTemplate

public static Template createFormButtonTemplate(int iconSize,
 float relativeFontSize)

createUiTemplate

public org.teamapps.dto.UiTemplate createUiTemplate()

Specified by:

createUiTemplate in interface Template

getPropertyNames

public List<String> getPropertyNames()

Specified by:

getPropertyNames in interface Template

getTemplate

public Template getTemplate()