freenet.node.useralerts

Class ProxyUserAlert

java.lang.Object

freenet.node.useralerts.AbstractUserAlert

freenet.node.useralerts.ProxyUserAlert

All Implemented Interfaces:

UserAlert

public class ProxyUserAlert
extends AbstractUserAlert

ProxyUserAlert - a UserAlert implementation that has a pointer to another UA. It can be set to null, in which case it is disabled, or to another UA. Thus we can have a bunch of UAs and switch between them knowing that more than one will never be displayed at the same time.

Field Summary

Fields inherited from class freenet.node.useralerts.AbstractUserAlert

valid

Fields inherited from interface freenet.node.useralerts.UserAlert

CRITICAL_ERROR, ERROR, MINOR, WARNING

Constructor Summary

Constructors

Constructor and Description
ProxyUserAlert(UserAlertManager uam, boolean autoRegister)

Method Summary

Modifier and Type	Method and Description
java.lang.String	anchor()
java.lang.String	dismissButtonText()
HTMLNode	getHTMLText() Content of alert (HTML).
short	getPriorityClass() Priority class
java.lang.String	getShortText() *Really* concise text of alert.
java.lang.String	getText() Content of alert (plain text).
java.lang.String	getTitle() Title of alert (must be short!).
boolean	isEventNotification()
boolean	isValid() Is the alert valid right now? Suggested use is to synchronize on the alert, then check this, then get the data.
void	isValid(boolean validity)
void	onDismiss() Method to be called upon alert dismissal
void	setAlert(UserAlert a)
boolean	shouldUnregisterOnDismiss()
boolean	userCanDismiss() Can the user dismiss the alert? If not, it persists until it is unregistered.

Methods inherited from class freenet.node.useralerts.AbstractUserAlert

getFCPMessage, getUpdatedTime, isEvent

Methods inherited from class java.lang.Object

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

Constructor Detail

ProxyUserAlert

public ProxyUserAlert(UserAlertManager uam,
                      boolean autoRegister)

Method Detail

setAlert

public void setAlert(UserAlert a)

userCanDismiss

public boolean userCanDismiss()

Description copied from class: AbstractUserAlert

Can the user dismiss the alert? If not, it persists until it is unregistered.

Specified by:

userCanDismiss in interface UserAlert

Overrides:

userCanDismiss in class AbstractUserAlert

getTitle

public java.lang.String getTitle()

Description copied from class: AbstractUserAlert

Title of alert (must be short!).

Specified by:

getTitle in interface UserAlert

Overrides:

getTitle in class AbstractUserAlert

getText

public java.lang.String getText()

Description copied from class: AbstractUserAlert

Content of alert (plain text).

Specified by:

getText in interface UserAlert

Overrides:

getText in class AbstractUserAlert

getHTMLText

public HTMLNode getHTMLText()

Description copied from class: AbstractUserAlert

Content of alert (HTML).

Specified by:

getHTMLText in interface UserAlert

Overrides:

getHTMLText in class AbstractUserAlert

getPriorityClass

public short getPriorityClass()

Description copied from class: AbstractUserAlert

Priority class

Specified by:

getPriorityClass in interface UserAlert

Overrides:

getPriorityClass in class AbstractUserAlert

isValid

public boolean isValid()

Description copied from class: AbstractUserAlert

Is the alert valid right now? Suggested use is to synchronize on the alert, then check this, then get the data.

Specified by:

isValid in interface UserAlert

Overrides:

isValid in class AbstractUserAlert

isValid

public void isValid(boolean validity)

Description copied from class: AbstractUserAlert

Specified by:

isValid in interface UserAlert

Overrides:

isValid in class AbstractUserAlert

dismissButtonText

public java.lang.String dismissButtonText()

Description copied from class: AbstractUserAlert

Specified by:

dismissButtonText in interface UserAlert

Overrides:

dismissButtonText in class AbstractUserAlert

shouldUnregisterOnDismiss

public boolean shouldUnregisterOnDismiss()

Description copied from class: AbstractUserAlert

Specified by:

shouldUnregisterOnDismiss in interface UserAlert

Overrides:

shouldUnregisterOnDismiss in class AbstractUserAlert

onDismiss

public void onDismiss()

Description copied from class: AbstractUserAlert

Method to be called upon alert dismissal

Specified by:

onDismiss in interface UserAlert

Overrides:

onDismiss in class AbstractUserAlert

anchor

public java.lang.String anchor()

Specified by:

anchor in interface UserAlert

Overrides:

anchor in class AbstractUserAlert

Returns:

A unique, short name for the alert. Can be simply hashCode(), not visible to the user. MUST NOT contain spaces or commas.

getShortText

public java.lang.String getShortText()

Description copied from interface: UserAlert

*Really* concise text of alert. Should be comfortably under a line even when translated into a verbose language. Will link to the full details.

Specified by:

getShortText in interface UserAlert

Overrides:

getShortText in class AbstractUserAlert

isEventNotification

public boolean isEventNotification()

Specified by:

isEventNotification in interface UserAlert

Overrides:

isEventNotification in class AbstractUserAlert

Returns:

True if this is an event notification. Event notifications can be bulk deleted. Eventually they will be handled differently - logged to a separate event log, and only the last few displayed on the homepage.