Package io.jmix.notificationsui.component.impl

Class NotificationsIndicatorImpl

java.lang.Object

io.jmix.ui.component.CompositeComponent<HBoxLayout>

io.jmix.notificationsui.component.impl.NotificationsIndicatorImpl

All Implemented Interfaces:

NotificationsIndicator, AttachNotifier, Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon, HasValueSource<String>, HasContextHelp, HasDebugId, HasFormatter<String>, HasHtmlDescription, HasHtmlSanitizer, HasValue<String>, Label<String>

public class NotificationsIndicatorImpl
extends CompositeComponent<HBoxLayout>
implements NotificationsIndicator

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.ui.component.CompositeComponent

CompositeComponent.CreateEvent

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasValue

HasValue.ValueChangeEvent<V>

Field Summary

Fields

Modifier and Type	Field	Description
protected AccessManager	accessManager
protected Label<String>	captionLabel
protected int	counter
protected Label<String>	counterLabel
protected int	countRenderLimit
protected CurrentAuthentication	currentAuthentication
protected DataManager	dataManager
protected boolean	hasAccessToInAppNotifications
protected Metadata	metadata
static final String	NOTIFICATION_INDICATOR_STYLENAME
protected Notifications	notifications
protected Screens	screens

Fields inherited from class io.jmix.ui.component.CompositeComponent

applicationContext, frame, id, prefixId, root

Fields inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Fields inherited from interface io.jmix.ui.component.Label

TYPE_BIGDECIMAL, TYPE_DATE, TYPE_DATETIME, TYPE_DEFAULT, TYPE_DOUBLE, TYPE_INTEGER, TYPE_LOCALDATE, TYPE_LOCALDATETIME, TYPE_LONG, TYPE_OFFSETTIME, TYPE_STRING, TYPE_TIME

Fields inherited from interface io.jmix.notificationsui.component.NotificationsIndicator

NAME

Constructor Summary

Constructors

Constructor	Description
NotificationsIndicatorImpl()

Method Summary

Modifier and Type	Method	Description
Subscription	addValueChangeListener(Consumer<HasValue.ValueChangeEvent<String>> listener)
String	getCaption()
Consumer<HasContextHelp.ContextHelpIconClickEvent>	getContextHelpIconClickHandler()
String	getContextHelpText()
int	getCount()	Returns current amount of unread notifications.
String	getDescription()
Formatter<String>	getFormatter()
String	getIcon()	Get icon source: "font-icon:ADD", "icons/myicon.png", "theme://createIcon", etc.
String	getRawValue()	Returns a string representation of the value.
String	getStyleName()	Styles implementation is client-type-specific.
String	getValue()
ValueSource<String>	getValueSource()
void	handlePushEvent(VaadinSessionNotificationEvent event)
protected boolean	hasAccessToInAppNotifications()
boolean	isContextHelpTextHtmlEnabled()
boolean	isDescriptionAsHtml()
boolean	isHtmlEnabled()
protected void	onCreate(CompositeComponent.CreateEvent createEvent)
protected void	openNotificationsList()
void	reloadCounter()	Reloads counter of amount of unread notifications.
void	setCaption(String caption)	Sets the component's caption.
void	setContextHelpIconClickHandler(Consumer<HasContextHelp.ContextHelpIconClickEvent> handler)	Sets a context help icon click handler.
void	setContextHelpText(String contextHelpText)	Sets context help text.
void	setContextHelpTextHtmlEnabled(boolean enabled)	Defines if context help text can be presented as HTML.
void	setDescription(String description)	Sets the component's description.
void	setDescriptionAsHtml(boolean descriptionAsHtml)	Sets whether the description is rendered as HTML.
void	setFormatter(Formatter<? super String> formatter)
void	setHtmlEnabled(boolean htmlEnabled)
void	setIcon(String icon)	Set an icon by its source: "font-icon:ADD", "icons/myicon.png", "theme://createIcon", etc.
void	setIconFromSet(Icons.Icon icon)	Set an icon from an icon set.
void	setStyleName(String styleName)	Sets one or more style names of the component, replacing any previous styles.
void	setValue(String value)
void	setValueSource(ValueSource<String> valueSource)	Sets value source for component.

Methods inherited from class io.jmix.ui.component.CompositeComponent

addAttachListener, addCreateListener, addDetachListener, addStyleName, assignDebugId, attached, detached, disableEventListeners, enableEventListeners, getAlignment, getComposition, getCompositionOrNull, getDebugId, getEventHub, getFrame, getFullId, getHeight, getHeightSizeUnit, getId, getInnerComponent, getInnerComponentOptional, getParent, getPrefixId, getUiEventListeners, getWidth, getWidthSizeUnit, hasSubscriptions, isAttached, isEnabled, isEnabledRecursive, isHtmlSanitizerEnabled, isResponsive, isVisible, isVisibleRecursive, publish, removeStyleName, setAlignment, setApplicationContext, setComposition, setDebugId, setEnabled, setFrame, setHeight, setHtmlSanitizerEnabled, setId, setParent, setResponsive, setUiEventListeners, setVisible, setWidth, unsubscribe, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, updateComponentIds, updateIdIfNeeded, withUnwrapped, withUnwrappedComposition

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jmix.ui.component.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface io.jmix.ui.component.HasHtmlSanitizer

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

Methods inherited from interface io.jmix.ui.component.HasValue

clear, getEmptyValue, isEmpty

Field Details

NOTIFICATION_INDICATOR_STYLENAME

public static final String NOTIFICATION_INDICATOR_STYLENAME

See Also:

• Constant Field Values

screens

@Autowired
protected Screens screens

dataManager

@Autowired
protected DataManager dataManager

currentAuthentication

@Autowired
protected CurrentAuthentication currentAuthentication

notifications

@Autowired
protected Notifications notifications

accessManager

@Autowired
protected AccessManager accessManager

metadata

@Autowired
protected Metadata metadata

captionLabel

protected Label<String> captionLabel

counterLabel

protected Label<String> counterLabel

counter

protected int counter

countRenderLimit

protected int countRenderLimit

hasAccessToInAppNotifications

protected boolean hasAccessToInAppNotifications

Constructor Details

NotificationsIndicatorImpl

public NotificationsIndicatorImpl()

Method Details

onCreate

protected void onCreate(CompositeComponent.CreateEvent createEvent)

reloadCounter

public void reloadCounter()

Description copied from interface: NotificationsIndicator

Reloads counter of amount of unread notifications.

Specified by:

reloadCounter in interface NotificationsIndicator

openNotificationsList

protected void openNotificationsList()

handlePushEvent

@EventListener(VaadinSessionNotificationEvent.class)
public void handlePushEvent(VaadinSessionNotificationEvent event)

getStyleName

public String getStyleName()

Description copied from interface: Component

Styles implementation is client-type-specific.

Specified by:

getStyleName in interface Component

Overrides:

getStyleName in class CompositeComponent<HBoxLayout>

Returns:

current style name.

setStyleName

public void setStyleName(@Nullable
 String styleName)

Description copied from interface: Component

Sets one or more style names of the component, replacing any previous styles. Multiple styles can be specified as a space-separated list of style names. Styles implementation is client-type-specific.

Specified by:

setStyleName in interface Component

Overrides:

setStyleName in class CompositeComponent<HBoxLayout>

Parameters:

styleName - one or more style names separated by space.

getCount

public int getCount()

Description copied from interface: NotificationsIndicator

Returns current amount of unread notifications.

Specified by:

getCount in interface NotificationsIndicator

Returns:

amount of unread notifications

isHtmlEnabled

public boolean isHtmlEnabled()

Specified by:

isHtmlEnabled in interface Label<String>

setHtmlEnabled

public void setHtmlEnabled(boolean htmlEnabled)

Specified by:

setHtmlEnabled in interface Label<String>

getRawValue

public String getRawValue()

Description copied from interface: Label

Returns a string representation of the value.

Specified by:

getRawValue in interface Label<String>

getValue

@Nullable
public String getValue()

Specified by:

getValue in interface HasValue<String>

setValue

public void setValue(@Nullable
 String value)

Specified by:

setValue in interface HasValue<String>

addValueChangeListener

public Subscription addValueChangeListener(Consumer<HasValue.ValueChangeEvent<String>> listener)

Specified by:

addValueChangeListener in interface HasValue<String>

getDescription

@Nullable
public String getDescription()

Specified by:

getDescription in interface Component.HasDescription

Returns:

the components description, used in tooltips

setDescription

public void setDescription(@Nullable
 String description)

Description copied from interface: Component.HasDescription

Sets the component's description.

Specified by:

setDescription in interface Component.HasDescription

Parameters:

description - the new description to set

getIcon

@Nullable
public String getIcon()

Description copied from interface: Component.HasIcon

Get icon source: "font-icon:ADD", "icons/myicon.png", "theme://createIcon", etc.

Specified by:

getIcon in interface Component.HasIcon

setIcon

public void setIcon(@Nullable
 String icon)

Description copied from interface: Component.HasIcon

Set an icon by its source: "font-icon:ADD", "icons/myicon.png", "theme://createIcon", etc.

Specified by:

setIcon in interface Component.HasIcon

setIconFromSet

public void setIconFromSet(@Nullable
 Icons.Icon icon)

Description copied from interface: Component.HasIcon

Set an icon from an icon set.

Specified by:

setIconFromSet in interface Component.HasIcon

getContextHelpText

@Nullable
public String getContextHelpText()

Specified by:

getContextHelpText in interface HasContextHelp

Returns:

context help text

setContextHelpText

public void setContextHelpText(@Nullable
 String contextHelpText)

Description copied from interface: HasContextHelp

Sets context help text. If set, then a special icon will be added for a field.

Specified by:

setContextHelpText in interface HasContextHelp

Parameters:

contextHelpText - context help text to be set

isContextHelpTextHtmlEnabled

public boolean isContextHelpTextHtmlEnabled()

Specified by:

isContextHelpTextHtmlEnabled in interface HasContextHelp

Returns:

true if field accepts context help text in HTML format, false otherwise

setContextHelpTextHtmlEnabled

public void setContextHelpTextHtmlEnabled(boolean enabled)

Description copied from interface: HasContextHelp

Defines if context help text can be presented as HTML.

Specified by:

setContextHelpTextHtmlEnabled in interface HasContextHelp

Parameters:

enabled - true if field accepts context help text in HTML format, false otherwise

getContextHelpIconClickHandler

@Nullable
public Consumer<HasContextHelp.ContextHelpIconClickEvent> getContextHelpIconClickHandler()

Specified by:

getContextHelpIconClickHandler in interface HasContextHelp

Returns:

a context help icon click handler

setContextHelpIconClickHandler

public void setContextHelpIconClickHandler(@Nullable
 Consumer<HasContextHelp.ContextHelpIconClickEvent> handler)

Description copied from interface: HasContextHelp

Sets a context help icon click handler. If set, then a special icon will be added for a field. Click handler has priority over context help text, i.e. no tooltip with context help text will be shown if click listener is set.

Specified by:

setContextHelpIconClickHandler in interface HasContextHelp

Parameters:

handler - the handler to set

getFormatter

@Nullable
public Formatter<String> getFormatter()

Specified by:

getFormatter in interface HasFormatter<String>

setFormatter

public void setFormatter(@Nullable
 Formatter<? super String> formatter)

Specified by:

setFormatter in interface HasFormatter<String>

isDescriptionAsHtml

public boolean isDescriptionAsHtml()

Specified by:

isDescriptionAsHtml in interface HasHtmlDescription

Returns:

true if the description is rendered as HTML, false if rendered as plain text

setDescriptionAsHtml

public void setDescriptionAsHtml(boolean descriptionAsHtml)

Description copied from interface: HasHtmlDescription

Sets whether the description is rendered as HTML.

Specified by:

setDescriptionAsHtml in interface HasHtmlDescription

Parameters:

descriptionAsHtml - true if the description is rendered as HTML, false if rendered as plain text

See Also:

• Component.HasDescription.setDescription(String)

setValueSource

public void setValueSource(@Nullable
 ValueSource<String> valueSource)

Description copied from interface: HasValueSource

Sets value source for component.

Specified by:

setValueSource in interface HasValueSource<String>

Parameters:

valueSource - value source

getValueSource

@Nullable
public ValueSource<String> getValueSource()

Specified by:

getValueSource in interface HasValueSource<String>

Returns:

currently bound value source

getCaption

@Nullable
public String getCaption()

Specified by:

getCaption in interface Component.HasCaption

Returns:

the caption of the component

setCaption

public void setCaption(@Nullable
 String caption)

Description copied from interface: Component.HasCaption

Sets the component's caption.

Specified by:

setCaption in interface Component.HasCaption

Parameters:

caption - the new component's caption

hasAccessToInAppNotifications

protected boolean hasAccessToInAppNotifications()