com.smartgwt.client.widgets.notify

Class NotifySettings

java.lang.Object

com.smartgwt.client.core.JsObject

com.smartgwt.client.core.DataClass

com.smartgwt.client.widgets.notify.NotifySettings

All Implemented Interfaces:

com.google.gwt.event.shared.HasHandlers

public class NotifySettings
extends DataClass

An object used to configure how messages shown by Notify.addMessage() are drawn and behave.

See Also:

Notify.addMessage(java.lang.String), Notify.configureMessages(java.lang.String, com.smartgwt.client.widgets.notify.NotifySettings)

Field Summary

Fields inherited from class com.smartgwt.client.core.DataClass

factoryCreated, factoryProperties

Fields inherited from class com.smartgwt.client.core.JsObject

jsObj

Constructor Summary

Constructors

Constructor and Description
NotifySettings()
NotifySettings(com.google.gwt.core.client.JavaScriptObject jsObj)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getActionSeparator() HTML to be added before each action to separate it from the previous action.
java.lang.String	getActionStyleName() The CSS class to apply to action text in this message.
NotifyTransition	getAppearMethod() Controls how messages appear at or reach their requested location.
boolean	getApplyPriorityToAppearance() Whether to default properties affecting the message appearance to those of the built-in NotifyType corresponding to the messagePriority.
java.lang.Integer	getAutoFitMaxWidth() Maximum auto-fit width for a message if autoFitWidth is enabled.
java.lang.String	getAutoFitMaxWidthAsString() Maximum auto-fit width for a message if autoFitWidth is enabled.
java.lang.Boolean	getAutoFitWidth() If true, the specified width of the Label drawn for this message will be treated as a minimum width.
java.lang.Boolean	getCanDismiss() Displays an icon to allow a message to be dismissed through the UI.
NotifyTransition	getDisappearMethod() Controls how messages disappear from or leave their requested location.
int	getDuration() Length of time a message is shown before being auto-dismissed, in milliseconds.
int	getFadeInDuration() Time over which the fade-in effect runs for NotifyTransition: "fade", in milliseconds.
int	getFadeOutDuration() Time over which the fade-out effect runs for NotifyTransition: "fade", in milliseconds.
Label	getLabelProperties() Configures the properties, such as Label.autoFit, Label.align, and Label.width.
java.lang.Integer	getLeftOffset() Specifies a left offset from the position specified by position or positionCanvas where the message should be shown.
MaxStackDismissMode	getMaxStackDismissMode() Specifies how to pick which message to dismiss when the maxStackSize is reached, and the lowest priority value (highest numerical messagePriority) is shared by more than one message.
int	getMaxStackSize() Sets a limit on how many messages may be stacked if MultiMessageMode is "stack".
java.lang.Integer	getMessageControlPadding() Optional specified padding to apply after the message content when showing a dismiss button so that the button doesn't occlude any content.
java.lang.String	getMessageIcon() Optional icon to be shown in the Label drawn for this message.
int	getMessageIconHeight() Height in pixels of the icon image.
java.lang.String	getMessageIconOrientation() If an icon is present, should it appear to the left or right of the title? valid options are "left" and "right".
int	getMessageIconSpacing() Pixels between icon and title text.
int	getMessageIconWidth() Width in pixels of the icon image.
int	getMessagePriority() Sets the priority of the message.
MultiMessageMode	getMultiMessageMode() Determines what happens if a message appears while there's still another one of the same NotifyType being shown.
static NotifySettings	getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
EdgeName	getPosition() Where to show the message, specified as an edge ("T", "B", "R", "L"), a corner ("TL", "TR", "BL", "BR), or "C" for center, similar to Canvas.snapTo.
Canvas	getPositionCanvas() Canvas over which to position the message, available as an alternative means of placement if viewport-relative coordinates aren't provided.
NotifyTransition	getRepositionMethod() Controls how the stack or message is repositioned, if required, after Notify.setMessageContents() has been called.
java.lang.String	getSlideInOrigin() Determines where messages originate when they appear for appearMethod: "slide".
java.lang.String	getSlideOutOrigin() Determines where messages go when they disappear for disappearMethod: "slide".
int	getSlideSpeed() Animation speed for NotifyTransition: "slide", in pixels/second.
StackDirection	getStackDirection() Determines how messages are stacked if MultiMessageMode is "stack".
StackPersistence	getStackPersistence() Controls how older messages' duration countdowns are affected when a new message of the same NotifyType appears.
int	getStackSpacing() Space between each message when MultiMessageMode is "stack".
boolean	getStayIfHovered() If true, pauses the auto-dismiss countdown timer when the mouse is over the messasge.
java.lang.String	getStyleName() The CSS class to apply to the Label drawn for this message.
java.lang.Integer	getTopOffset() Specifies a top offset from the position specified by position or positionCanvas where the message should be shown.
java.lang.Integer	getX() Where to show the message, as a viewport-relative x coordinate offset to the left edge of the Label rendering the message.
java.lang.Integer	getY() Where to show the message, as a viewport-relative y coordinate offset to the top edge of the Label rendering the message.
NotifySettings	setActionSeparator(java.lang.String actionSeparator) HTML to be added before each action to separate it from the previous action.
NotifySettings	setActionStyleName(java.lang.String actionStyleName) The CSS class to apply to action text in this message.
NotifySettings	setAppearMethod(NotifyTransition appearMethod) Controls how messages appear at or reach their requested location.
NotifySettings	setApplyPriorityToAppearance(boolean applyPriorityToAppearance) Whether to default properties affecting the message appearance to those of the built-in NotifyType corresponding to the messagePriority.
NotifySettings	setAutoFitMaxWidth(java.lang.Integer autoFitMaxWidth) Maximum auto-fit width for a message if autoFitWidth is enabled.
NotifySettings	setAutoFitMaxWidth(java.lang.String autoFitMaxWidth) Maximum auto-fit width for a message if autoFitWidth is enabled.
NotifySettings	setAutoFitWidth(java.lang.Boolean autoFitWidth) If true, the specified width of the Label drawn for this message will be treated as a minimum width.
NotifySettings	setCanDismiss(java.lang.Boolean canDismiss) Displays an icon to allow a message to be dismissed through the UI.
NotifySettings	setDisappearMethod(NotifyTransition disappearMethod) Controls how messages disappear from or leave their requested location.
NotifySettings	setDuration(int duration) Length of time a message is shown before being auto-dismissed, in milliseconds.
NotifySettings	setFadeInDuration(int fadeInDuration) Time over which the fade-in effect runs for NotifyTransition: "fade", in milliseconds.
NotifySettings	setFadeOutDuration(int fadeOutDuration) Time over which the fade-out effect runs for NotifyTransition: "fade", in milliseconds.
NotifySettings	setLabelProperties(Label labelProperties) Configures the properties, such as Label.autoFit, Label.align, and Label.width.
NotifySettings	setLeftOffset(java.lang.Integer leftOffset) Specifies a left offset from the position specified by position or positionCanvas where the message should be shown.
NotifySettings	setMaxStackDismissMode(MaxStackDismissMode maxStackDismissMode) Specifies how to pick which message to dismiss when the maxStackSize is reached, and the lowest priority value (highest numerical messagePriority) is shared by more than one message.
NotifySettings	setMaxStackSize(int maxStackSize) Sets a limit on how many messages may be stacked if MultiMessageMode is "stack".
NotifySettings	setMessageControlPadding(java.lang.Integer messageControlPadding) Optional specified padding to apply after the message content when showing a dismiss button so that the button doesn't occlude any content.
NotifySettings	setMessageIcon(java.lang.String messageIcon) Optional icon to be shown in the Label drawn for this message.
NotifySettings	setMessageIconHeight(int messageIconHeight) Height in pixels of the icon image.
NotifySettings	setMessageIconOrientation(java.lang.String messageIconOrientation) If an icon is present, should it appear to the left or right of the title? valid options are "left" and "right".
NotifySettings	setMessageIconSpacing(int messageIconSpacing) Pixels between icon and title text.
NotifySettings	setMessageIconWidth(int messageIconWidth) Width in pixels of the icon image.
NotifySettings	setMessagePriority(int messagePriority) Sets the priority of the message.
NotifySettings	setMultiMessageMode(MultiMessageMode multiMessageMode) Determines what happens if a message appears while there's still another one of the same NotifyType being shown.
NotifySettings	setPosition(EdgeName position) Where to show the message, specified as an edge ("T", "B", "R", "L"), a corner ("TL", "TR", "BL", "BR), or "C" for center, similar to Canvas.snapTo.
NotifySettings	setPositionCanvas(Canvas positionCanvas) Canvas over which to position the message, available as an alternative means of placement if viewport-relative coordinates aren't provided.
NotifySettings	setRepositionMethod(NotifyTransition repositionMethod) Controls how the stack or message is repositioned, if required, after Notify.setMessageContents() has been called.
NotifySettings	setSlideInOrigin(java.lang.String slideInOrigin) Determines where messages originate when they appear for appearMethod: "slide".
NotifySettings	setSlideOutOrigin(java.lang.String slideOutOrigin) Determines where messages go when they disappear for disappearMethod: "slide".
NotifySettings	setSlideSpeed(int slideSpeed) Animation speed for NotifyTransition: "slide", in pixels/second.
NotifySettings	setStackDirection(StackDirection stackDirection) Determines how messages are stacked if MultiMessageMode is "stack".
NotifySettings	setStackPersistence(StackPersistence stackPersistence) Controls how older messages' duration countdowns are affected when a new message of the same NotifyType appears.
NotifySettings	setStackSpacing(int stackSpacing) Space between each message when MultiMessageMode is "stack".
NotifySettings	setStayIfHovered(boolean stayIfHovered) If true, pauses the auto-dismiss countdown timer when the mouse is over the messasge.
NotifySettings	setStyleName(java.lang.String styleName) The CSS class to apply to the Label drawn for this message.
NotifySettings	setTopOffset(java.lang.Integer topOffset) Specifies a top offset from the position specified by position or positionCanvas where the message should be shown.
NotifySettings	setX(java.lang.Integer x) Where to show the message, as a viewport-relative x coordinate offset to the left edge of the Label rendering the message.
NotifySettings	setY(java.lang.Integer y) Where to show the message, as a viewport-relative y coordinate offset to the top edge of the Label rendering the message.

Methods inherited from class com.smartgwt.client.core.DataClass

applyFactoryProperties, doAddHandler, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsDoubleArray, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getAttributes, getHandlerCount, isFactoryCreated, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject, setFactoryCreated

Methods inherited from class com.smartgwt.client.core.JsObject

equals, getJsObj, hashCode, isCreated, setJavaScriptObject, setJsObj

Methods inherited from class java.lang.Object

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

Constructor Detail

NotifySettings

public NotifySettings()

NotifySettings

public NotifySettings(com.google.gwt.core.client.JavaScriptObject jsObj)

Method Detail

getOrCreateRef

public static NotifySettings getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)

setActionSeparator

public NotifySettings setActionSeparator(java.lang.String actionSeparator)

HTML to be added before each action to separate it from the previous action. For the first action, it will only be added if the message contents aren't empty.

You may override this on a per action basis using NotifyAction.separator.

Besides the default, some other known useful values are " " and " ".

Parameters:

actionSeparator - New actionSeparator value. Default value is " "

Returns:

NotifySettings instance, for chaining setter calls

See Also:

HTMLString

getActionSeparator

public java.lang.String getActionSeparator()

HTML to be added before each action to separate it from the previous action. For the first action, it will only be added if the message contents aren't empty.

You may override this on a per action basis using NotifyAction.separator.

Besides the default, some other known useful values are " " and " ".

Returns:

Current actionSeparator value. Default value is " "

See Also:

HTMLString

setActionStyleName

public NotifySettings setActionStyleName(java.lang.String actionStyleName)

The CSS class to apply to action text in this message. default is:

• "notifyErrorActionLink" for NotifyType: "error",
• "notifyWarnActionLink" for NotifyType: "warn", and
• "notifyMessageActionLink" for all other NotifyTypes.

However, if you specify a messagePriority, it will determine the default rather than the actual NotifyType, if applyPriorityToAppearance is true.

Parameters:

actionStyleName - New actionStyleName value. Default value is varies

Returns:

NotifySettings instance, for chaining setter calls

See Also:

setMessagePriority(int), CSSStyleName

getActionStyleName

public java.lang.String getActionStyleName()

The CSS class to apply to action text in this message. default is:

• "notifyErrorActionLink" for NotifyType: "error",
• "notifyWarnActionLink" for NotifyType: "warn", and
• "notifyMessageActionLink" for all other NotifyTypes.

However, if you specify a messagePriority, it will determine the default rather than the actual NotifyType, if applyPriorityToAppearance is true.

Returns:

Current actionStyleName value. Default value is varies

See Also:

getMessagePriority(), CSSStyleName

setAppearMethod

public NotifySettings setAppearMethod(NotifyTransition appearMethod)

Controls how messages appear at or reach their requested location. The default of "slide" is recommended because the motion will draw the user's attention to the notification.

Parameters:

appearMethod - New appearMethod value. Default value is "slide"

Returns:

NotifySettings instance, for chaining setter calls

getAppearMethod

public NotifyTransition getAppearMethod()

Controls how messages appear at or reach their requested location. The default of "slide" is recommended because the motion will draw the user's attention to the notification.

Returns:

Current appearMethod value. Default value is "slide"

setApplyPriorityToAppearance

public NotifySettings setApplyPriorityToAppearance(boolean applyPriorityToAppearance)

Whether to default properties affecting the message appearance to those of the built-in NotifyType corresponding to the messagePriority. Default is true except for NotifyTypes "error" and "warn", which default to false.

Note : This is an advanced setting

Parameters:

applyPriorityToAppearance - New applyPriorityToAppearance value. Default value is varies

Returns:

NotifySettings instance, for chaining setter calls

See Also:

setMessagePriority(int)

getApplyPriorityToAppearance

public boolean getApplyPriorityToAppearance()

Whether to default properties affecting the message appearance to those of the built-in NotifyType corresponding to the messagePriority. Default is true except for NotifyTypes "error" and "warn", which default to false.

Returns:

Current applyPriorityToAppearance value. Default value is varies

See Also:

getMessagePriority()

setAutoFitMaxWidth

public NotifySettings setAutoFitMaxWidth(java.lang.Integer autoFitMaxWidth)

Maximum auto-fit width for a message if autoFitWidth is enabled. May be specified as a pixel value, or a percentage of page width.

Parameters:

autoFitMaxWidth - New autoFitMaxWidth value. Default value is 300

Returns:

NotifySettings instance, for chaining setter calls

See Also:

setAutoFitWidth(java.lang.Boolean)

getAutoFitMaxWidth

public java.lang.Integer getAutoFitMaxWidth()

Maximum auto-fit width for a message if autoFitWidth is enabled. May be specified as a pixel value, or a percentage of page width.

Returns:

Current autoFitMaxWidth value. Default value is 300

See Also:

getAutoFitWidth()

setAutoFitMaxWidth

public NotifySettings setAutoFitMaxWidth(java.lang.String autoFitMaxWidth)

Maximum auto-fit width for a message if autoFitWidth is enabled. May be specified as a pixel value, or a percentage of page width.

Parameters:

autoFitMaxWidth - New autoFitMaxWidth value. Default value is 300

Returns:

NotifySettings instance, for chaining setter calls

See Also:

setAutoFitWidth(java.lang.Boolean)

getAutoFitMaxWidthAsString

public java.lang.String getAutoFitMaxWidthAsString()

Maximum auto-fit width for a message if autoFitWidth is enabled. May be specified as a pixel value, or a percentage of page width.

Returns:

Current autoFitMaxWidth value. Default value is 300

See Also:

getAutoFitWidth()

setAutoFitWidth

public NotifySettings setAutoFitWidth(java.lang.Boolean autoFitWidth)

If true, the specified width of the Label drawn for this message will be treated as a minimum width. If the message content string exceeds this, the Label will expand to accommodate it up to autoFitMaxWidth (without the text wrapping).

Using this setting differs from simply disabling wrapping via wrap:false as the content will wrap if the autoFitMaxWidth is exceeded.

Note : This is an advanced setting

Parameters:

autoFitWidth - New autoFitWidth value. Default value is null

Returns:

NotifySettings instance, for chaining setter calls

getAutoFitWidth

public java.lang.Boolean getAutoFitWidth()

If true, the specified width of the Label drawn for this message will be treated as a minimum width. If the message content string exceeds this, the Label will expand to accommodate it up to autoFitMaxWidth (without the text wrapping).

Using this setting differs from simply disabling wrapping via wrap:false as the content will wrap if the autoFitMaxWidth is exceeded.

Returns:

Current autoFitWidth value. Default value is null

setCanDismiss

public NotifySettings setCanDismiss(java.lang.Boolean canDismiss)

Displays an icon to allow a message to be dismissed through the UI. Messages can always be dismissed programmatically by calling Notify.dismissMessage().

Parameters:

canDismiss - New canDismiss value. Default value is false

Returns:

NotifySettings instance, for chaining setter calls

getCanDismiss

public java.lang.Boolean getCanDismiss()

Displays an icon to allow a message to be dismissed through the UI. Messages can always be dismissed programmatically by calling Notify.dismissMessage().

Returns:

Current canDismiss value. Default value is false

setDisappearMethod

public NotifySettings setDisappearMethod(NotifyTransition disappearMethod)

Controls how messages disappear from or leave their requested location. The default of "fade" is recommended because a slide animation would draw too much attention to a notification that is no longer current, whereas a subtle fade should draw a minimum of attention (less even than instantaneously disappearing).

Parameters:

disappearMethod - New disappearMethod value. Default value is "fade"

Returns:

NotifySettings instance, for chaining setter calls

getDisappearMethod

public NotifyTransition getDisappearMethod()

Controls how messages disappear from or leave their requested location. The default of "fade" is recommended because a slide animation would draw too much attention to a notification that is no longer current, whereas a subtle fade should draw a minimum of attention (less even than instantaneously disappearing).

Returns:

Current disappearMethod value. Default value is "fade"

setDuration

public NotifySettings setDuration(int duration)

Length of time a message is shown before being auto-dismissed, in milliseconds. A value of 0 means that the message will not be dismissed automatically. Messages can always be dismissed by calling Notify.dismissMessage() or, if canDismiss is set, by performing a "close click".

Parameters:

duration - New duration value. Default value is 5000

Returns:

NotifySettings instance, for chaining setter calls

getDuration

public int getDuration()

Length of time a message is shown before being auto-dismissed, in milliseconds. A value of 0 means that the message will not be dismissed automatically. Messages can always be dismissed by calling Notify.dismissMessage() or, if canDismiss is set, by performing a "close click".

Returns:

Current duration value. Default value is 5000

setFadeInDuration

public NotifySettings setFadeInDuration(int fadeInDuration)

Time over which the fade-in effect runs for NotifyTransition: "fade", in milliseconds.

Parameters:

fadeInDuration - New fadeInDuration value. Default value is 500

Returns:

NotifySettings instance, for chaining setter calls

getFadeInDuration

public int getFadeInDuration()

Time over which the fade-in effect runs for NotifyTransition: "fade", in milliseconds.

Returns:

Current fadeInDuration value. Default value is 500

setFadeOutDuration

public NotifySettings setFadeOutDuration(int fadeOutDuration)

Time over which the fade-out effect runs for NotifyTransition: "fade", in milliseconds.

Parameters:

fadeOutDuration - New fadeOutDuration value. Default value is 500

Returns:

NotifySettings instance, for chaining setter calls

getFadeOutDuration

public int getFadeOutDuration()

Time over which the fade-out effect runs for NotifyTransition: "fade", in milliseconds.

Returns:

Current fadeOutDuration value. Default value is 500

setLabelProperties

public NotifySettings setLabelProperties(Label labelProperties)

Configures the properties, such as Label.autoFit, Label.align, and Label.width. of the Label autochildren that will be used to draw messages, where not already determined by message layout or other NotifySettings properties such as styleName.

Not all label properties are guaranteed to work here, as the Notify system is assumed to layout message content and manage positioning messages. In particular, the following properties should be avoided:

Property Name	Issue	Guidance
margin	Layout and positioning of the messages is handled by the Notify system.	Use stackSpacing to configure the separation between messages, and leftOffset and topOffset to fine-tine stack positioning.
padding	Padding is set by notification CSS so that children are positioned corrected relative to content.	You can apply your own styling to messages via CSS. Or you can use HTML as the message contents to create whatever sort of interior layout you like.
wrap	Autowrap behavior is managed by the Notify system.	To have autofitted content not wrap, set autoFitMaxWidth higher than your expected message widths. You can set it to "100%" if needed to allow the message to expand across the entire page.

Parameters:

labelProperties - New labelProperties value. Default value is null

Returns:

NotifySettings instance, for chaining setter calls

See Also:

SGWTProperties

getLabelProperties

public Label getLabelProperties()

Configures the properties, such as Label.autoFit, Label.align, and Label.width. of the Label autochildren that will be used to draw messages, where not already determined by message layout or other NotifySettings properties such as styleName.

Not all label properties are guaranteed to work here, as the Notify system is assumed to layout message content and manage positioning messages. In particular, the following properties should be avoided:

Property Name	Issue	Guidance
margin	Layout and positioning of the messages is handled by the Notify system.	Use stackSpacing to configure the separation between messages, and leftOffset and topOffset to fine-tine stack positioning.
padding	Padding is set by notification CSS so that children are positioned corrected relative to content.	You can apply your own styling to messages via CSS. Or you can use HTML as the message contents to create whatever sort of interior layout you like.
wrap	Autowrap behavior is managed by the Notify system.	To have autofitted content not wrap, set autoFitMaxWidth higher than your expected message widths. You can set it to "100%" if needed to allow the message to expand across the entire page.

Returns:

Current labelProperties value. Default value is null

setLeftOffset

public NotifySettings setLeftOffset(java.lang.Integer leftOffset)

Specifies a left offset from the position specified by position or positionCanvas where the message should be shown. Ignored if coordinates are provided to position the message.

Parameters:

leftOffset - New leftOffset value. Default value is null

Returns:

NotifySettings instance, for chaining setter calls

See Also:

setPosition(com.smartgwt.client.types.EdgeName), setTopOffset(java.lang.Integer)

getLeftOffset

public java.lang.Integer getLeftOffset()

Specifies a left offset from the position specified by position or positionCanvas where the message should be shown. Ignored if coordinates are provided to position the message.

Returns:

Current leftOffset value. Default value is null

See Also:

getPosition(), getTopOffset()

setMaxStackDismissMode

public NotifySettings setMaxStackDismissMode(MaxStackDismissMode maxStackDismissMode)

Specifies how to pick which message to dismiss when the maxStackSize is reached, and the lowest priority value (highest numerical messagePriority) is shared by more than one message.

We can simply dismiss the oldest message of that messagePriority, or we can pick the message with the least time left until it's auto-dismissed.

Parameters:

maxStackDismissMode - New maxStackDismissMode value. Default value is "oldest"

Returns:

NotifySettings instance, for chaining setter calls

See Also:

setDuration(int), Notify.dismissMessage(com.smartgwt.client.widgets.notify.MessageID)

getMaxStackDismissMode

public MaxStackDismissMode getMaxStackDismissMode()

Specifies how to pick which message to dismiss when the maxStackSize is reached, and the lowest priority value (highest numerical messagePriority) is shared by more than one message.

We can simply dismiss the oldest message of that messagePriority, or we can pick the message with the least time left until it's auto-dismissed.

Returns:

Current maxStackDismissMode value. Default value is "oldest"

See Also:

getDuration(), Notify.dismissMessage(com.smartgwt.client.widgets.notify.MessageID)

setMaxStackSize

public NotifySettings setMaxStackSize(int maxStackSize)

Sets a limit on how many messages may be stacked if MultiMessageMode is "stack". The oldest message of the affected NotifyType will be dismissed to enforce this limit.

Parameters:

maxStackSize - New maxStackSize value. Default value is 3

Returns:

NotifySettings instance, for chaining setter calls

getMaxStackSize

public int getMaxStackSize()

Sets a limit on how many messages may be stacked if MultiMessageMode is "stack". The oldest message of the affected NotifyType will be dismissed to enforce this limit.

Returns:

Current maxStackSize value. Default value is 3

setMessageControlPadding

public NotifySettings setMessageControlPadding(java.lang.Integer messageControlPadding)

Optional specified padding to apply after the message content when showing a dismiss button so that the button doesn't occlude any content. Only needed if the message styling doesn't already provide enough padding.

Parameters:

messageControlPadding - New messageControlPadding value. Default value is null

Returns:

NotifySettings instance, for chaining setter calls

getMessageControlPadding

public java.lang.Integer getMessageControlPadding()

Optional specified padding to apply after the message content when showing a dismiss button so that the button doesn't occlude any content. Only needed if the message styling doesn't already provide enough padding.

Returns:

Current messageControlPadding value. Default value is null

setMessageIcon

public NotifySettings setMessageIcon(java.lang.String messageIcon)

Optional icon to be shown in the Label drawn for this message. Default is

• "[SKIN]/Notify/error.png" for NotifyType: "error",
• "[SKIN]/Notify/warning.png" for NotifyType: "warn", and
• "[SKIN]/Notify/checkmark.png" for all other NotifyTypes.

However, if you specify a messagePriority, it will determine the default rather than the actual NotifyType, if applyPriorityToAppearance is true.

Parameters:

messageIcon - New messageIcon value. Default value is varies

Returns:

NotifySettings instance, for chaining setter calls

See Also:

setMessagePriority(int), SCImgURL

getMessageIcon

public java.lang.String getMessageIcon()

Optional icon to be shown in the Label drawn for this message. Default is

• "[SKIN]/Notify/error.png" for NotifyType: "error",
• "[SKIN]/Notify/warning.png" for NotifyType: "warn", and
• "[SKIN]/Notify/checkmark.png" for all other NotifyTypes.

However, if you specify a messagePriority, it will determine the default rather than the actual NotifyType, if applyPriorityToAppearance is true.

Returns:

Current messageIcon value. Default value is varies

See Also:

getMessagePriority(), SCImgURL

setMessageIconHeight

public NotifySettings setMessageIconHeight(int messageIconHeight)

Height in pixels of the icon image.

Parameters:

messageIconHeight - New messageIconHeight value. Default value is 17

Returns:

NotifySettings instance, for chaining setter calls

See Also:

Label.setIconHeight(java.lang.Integer)

getMessageIconHeight

public int getMessageIconHeight()

Height in pixels of the icon image.

Returns:

Current messageIconHeight value. Default value is 17

See Also:

Label.getIconHeight()

setMessageIconOrientation

public NotifySettings setMessageIconOrientation(java.lang.String messageIconOrientation)

If an icon is present, should it appear to the left or right of the title? valid options are "left" and "right". If unset, default is "left" unless RTL is active, in which case it's "right".

Note that the icon will automatically be given an alignment matching its orientation, so "left" for messageIconOrientation "left", and vice versa.

Parameters:

messageIconOrientation - New messageIconOrientation value. Default value is varies

Returns:

NotifySettings instance, for chaining setter calls

See Also:

Label.setIconAlign(java.lang.String), Label.setIconOrientation(java.lang.String)

getMessageIconOrientation

public java.lang.String getMessageIconOrientation()

If an icon is present, should it appear to the left or right of the title? valid options are "left" and "right". If unset, default is "left" unless RTL is active, in which case it's "right".

Note that the icon will automatically be given an alignment matching its orientation, so "left" for messageIconOrientation "left", and vice versa.

Returns:

Current messageIconOrientation value. Default value is varies

See Also:

Label.getIconAlign(), Label.getIconOrientation()

setMessageIconSpacing

public NotifySettings setMessageIconSpacing(int messageIconSpacing)

Pixels between icon and title text.

Parameters:

messageIconSpacing - New messageIconSpacing value. Default value is 20

Returns:

NotifySettings instance, for chaining setter calls

See Also:

Label.setIconSpacing(int)

getMessageIconSpacing

public int getMessageIconSpacing()

Pixels between icon and title text.

Returns:

Current messageIconSpacing value. Default value is 20

See Also:

Label.getIconSpacing()

setMessageIconWidth

public NotifySettings setMessageIconWidth(int messageIconWidth)

Width in pixels of the icon image.

Parameters:

messageIconWidth - New messageIconWidth value. Default value is 17

Returns:

NotifySettings instance, for chaining setter calls

See Also:

Label.setIconWidth(java.lang.Integer)

getMessageIconWidth

public int getMessageIconWidth()

Width in pixels of the icon image.

Returns:

Current messageIconWidth value. Default value is 17

See Also:

Label.getIconWidth()

setMessagePriority

public NotifySettings setMessagePriority(int messagePriority)

Sets the priority of the message. Priority is used to determine which message to dismiss if maxStackSize is hit. Lower numerical values have higher priority.

The default is:

• ERROR for NotifyType: "error",
• WARN for NotifyType: "warn", and
• MESSAGE for all other NotifyTypes

Impact on Appearance

If you specify messagePriority, and applyPriorityToAppearance is set, the properties:

• messageIcon,
• styleName, and
• actionStyleName

will be assigned, if not specified, to the default values from:

• NotifyType: "error" for priority ERROR,
• NotifyType: "warn" for priority WARN, or
• NotifyType: "message" for priorities at or below MESSAGE (greater or equal numerically)

This allows you to automatically set "error" or "warn" styling, on a per-message basis, for any non-"error" or "warn" NotifyType by simply supplying a messagePriority for that message.

Note : This is an advanced setting

Parameters:

messagePriority - New messagePriority value. Default value is varies

Returns:

NotifySettings instance, for chaining setter calls

See Also:

Notify.addMessage(java.lang.String), setMaxStackDismissMode(com.smartgwt.client.types.MaxStackDismissMode)

getMessagePriority

public int getMessagePriority()

Sets the priority of the message. Priority is used to determine which message to dismiss if maxStackSize is hit. Lower numerical values have higher priority.

The default is:

• ERROR for NotifyType: "error",
• WARN for NotifyType: "warn", and
• MESSAGE for all other NotifyTypes

Impact on Appearance

If you specify messagePriority, and applyPriorityToAppearance is set, the properties:

• messageIcon,
• styleName, and
• actionStyleName

will be assigned, if not specified, to the default values from:

• NotifyType: "error" for priority ERROR,
• NotifyType: "warn" for priority WARN, or
• NotifyType: "message" for priorities at or below MESSAGE (greater or equal numerically)

This allows you to automatically set "error" or "warn" styling, on a per-message basis, for any non-"error" or "warn" NotifyType by simply supplying a messagePriority for that message.

Returns:

Current messagePriority value. Default value is varies

See Also:

Notify.addMessage(java.lang.String), getMaxStackDismissMode()

setMultiMessageMode

public NotifySettings setMultiMessageMode(MultiMessageMode multiMessageMode)

Determines what happens if a message appears while there's still another one of the same NotifyType being shown. Such messages are either stacked or replace one another,

Parameters:

multiMessageMode - New multiMessageMode value. Default value is "stack"

Returns:

NotifySettings instance, for chaining setter calls

getMultiMessageMode

public MultiMessageMode getMultiMessageMode()

Determines what happens if a message appears while there's still another one of the same NotifyType being shown. Such messages are either stacked or replace one another,

Returns:

Current multiMessageMode value. Default value is "stack"

setPosition

public NotifySettings setPosition(EdgeName position)

Where to show the message, specified as an edge ("T", "B", "R", "L"), a corner ("TL", "TR", "BL", "BR), or "C" for center, similar to Canvas.snapTo. If an edge is specified, the message will be shown at its center (or the very center for "C"). Only used if coordinates haven't been provided.

If a positionCanvas has been specified, the position is interpreted relative to it instead of the viewport, and this property defaults to "C". Otherwise, if no positionCanvas is present, the default is to use slideInOrigin or slideOutOrigin, or "L" if neither property is defined.

To place the message at an offset from the specified position, use leftOffset or topOffset.

Parameters:

position - New position value. Default value is varies

Returns:

NotifySettings instance, for chaining setter calls

See Also:

setX(java.lang.Integer), setY(java.lang.Integer), setPositionCanvas(com.smartgwt.client.widgets.Canvas)

getPosition

public EdgeName getPosition()

Where to show the message, specified as an edge ("T", "B", "R", "L"), a corner ("TL", "TR", "BL", "BR), or "C" for center, similar to Canvas.snapTo. If an edge is specified, the message will be shown at its center (or the very center for "C"). Only used if coordinates haven't been provided.

If a positionCanvas has been specified, the position is interpreted relative to it instead of the viewport, and this property defaults to "C". Otherwise, if no positionCanvas is present, the default is to use slideInOrigin or slideOutOrigin, or "L" if neither property is defined.

To place the message at an offset from the specified position, use leftOffset or topOffset.

Returns:

Current position value. Default value is varies

See Also:

getX(), getY(), getPositionCanvas()

setPositionCanvas

public NotifySettings setPositionCanvas(Canvas positionCanvas)

Canvas over which to position the message, available as an alternative means of placement if viewport-relative coordinates aren't provided. Note that the canvas is only used to compute where to the place message, and will not be altered.

Parameters:

positionCanvas - New positionCanvas value. Default value is null

Returns:

NotifySettings instance, for chaining setter calls

See Also:

setLeftOffset(java.lang.Integer), setTopOffset(java.lang.Integer), setPosition(com.smartgwt.client.types.EdgeName)

getPositionCanvas

public Canvas getPositionCanvas()

Canvas over which to position the message, available as an alternative means of placement if viewport-relative coordinates aren't provided. Note that the canvas is only used to compute where to the place message, and will not be altered.

Returns:

Current positionCanvas value. Default value is null

See Also:

getLeftOffset(), getTopOffset(), getPosition()

setRepositionMethod

public NotifySettings setRepositionMethod(NotifyTransition repositionMethod)

Controls how the stack or message is repositioned, if required, after Notify.setMessageContents() has been called. Valid values are "slide" and "instant".

Parameters:

repositionMethod - New repositionMethod value. Default value is "slide"

Returns:

NotifySettings instance, for chaining setter calls

getRepositionMethod

public NotifyTransition getRepositionMethod()

Controls how the stack or message is repositioned, if required, after Notify.setMessageContents() has been called. Valid values are "slide" and "instant".

Returns:

Current repositionMethod value. Default value is "slide"

setSlideInOrigin

public NotifySettings setSlideInOrigin(java.lang.String slideInOrigin)

Determines where messages originate when they appear for appearMethod: "slide". Possible values are "L", "R", "T", and "B".

If not specified, the edge nearest the message's requested coordinates or position is used.

Parameters:

slideInOrigin - New slideInOrigin value. Default value is null

Returns:

NotifySettings instance, for chaining setter calls

getSlideInOrigin

public java.lang.String getSlideInOrigin()

Determines where messages originate when they appear for appearMethod: "slide". Possible values are "L", "R", "T", and "B".

If not specified, the edge nearest the message's requested coordinates or position is used.

Returns:

Current slideInOrigin value. Default value is null

setSlideOutOrigin

public NotifySettings setSlideOutOrigin(java.lang.String slideOutOrigin)

Determines where messages go when they disappear for disappearMethod: "slide". Possible values are "L", "R", "T", and "B".

If not specified, the edge nearest the message's requested coordinates or position is used.

Parameters:

slideOutOrigin - New slideOutOrigin value. Default value is null

Returns:

NotifySettings instance, for chaining setter calls

getSlideOutOrigin

public java.lang.String getSlideOutOrigin()

Determines where messages go when they disappear for disappearMethod: "slide". Possible values are "L", "R", "T", and "B".

If not specified, the edge nearest the message's requested coordinates or position is used.

Returns:

Current slideOutOrigin value. Default value is null

setSlideSpeed

public NotifySettings setSlideSpeed(int slideSpeed)

Animation speed for NotifyTransition: "slide", in pixels/second.

Parameters:

slideSpeed - New slideSpeed value. Default value is 300

Returns:

NotifySettings instance, for chaining setter calls

getSlideSpeed

public int getSlideSpeed()

Animation speed for NotifyTransition: "slide", in pixels/second.

Returns:

Current slideSpeed value. Default value is 300

setStackDirection

public NotifySettings setStackDirection(StackDirection stackDirection)

Determines how messages are stacked if MultiMessageMode is "stack". For example, "down" means that older messages move down when a new message of the same NotifyType appears.

Parameters:

stackDirection - New stackDirection value. Default value is "down"

Returns:

NotifySettings instance, for chaining setter calls

getStackDirection

public StackDirection getStackDirection()

Determines how messages are stacked if MultiMessageMode is "stack". For example, "down" means that older messages move down when a new message of the same NotifyType appears.

Returns:

Current stackDirection value. Default value is "down"

setStackPersistence

public NotifySettings setStackPersistence(StackPersistence stackPersistence)

Controls how older messages' duration countdowns are affected when a new message of the same NotifyType appears. We either continue the countdowns on the older messages as if they are unrelated, or we reset any countdowns that are less than the new message's duration.

Note that you can set this property in a call to Notify.addMessage() even though it has "stack" in its name, since it governs the logic run on behalf of this message.

Note : This is an advanced setting

Parameters:

stackPersistence - New stackPersistence value. Default value is "none"

Returns:

NotifySettings instance, for chaining setter calls

getStackPersistence

public StackPersistence getStackPersistence()

Controls how older messages' duration countdowns are affected when a new message of the same NotifyType appears. We either continue the countdowns on the older messages as if they are unrelated, or we reset any countdowns that are less than the new message's duration.

Note that you can set this property in a call to Notify.addMessage() even though it has "stack" in its name, since it governs the logic run on behalf of this message.

Returns:

Current stackPersistence value. Default value is "none"

setStackSpacing

public NotifySettings setStackSpacing(int stackSpacing)

Space between each message when MultiMessageMode is "stack".

Parameters:

stackSpacing - New stackSpacing value. Default value is 2

Returns:

NotifySettings instance, for chaining setter calls

getStackSpacing

public int getStackSpacing()

Space between each message when MultiMessageMode is "stack".

Returns:

Current stackSpacing value. Default value is 2

setStayIfHovered

public NotifySettings setStayIfHovered(boolean stayIfHovered)

If true, pauses the auto-dismiss countdown timer when the mouse is over the messasge.

Parameters:

stayIfHovered - New stayIfHovered value. Default value is false

Returns:

NotifySettings instance, for chaining setter calls

getStayIfHovered

public boolean getStayIfHovered()

If true, pauses the auto-dismiss countdown timer when the mouse is over the messasge.

Returns:

Current stayIfHovered value. Default value is false

setStyleName

public NotifySettings setStyleName(java.lang.String styleName)

The CSS class to apply to the Label drawn for this message. Default is:

• "notifyError" for NotifyType: "error",
• "notifyWarn" for NotifyType: "warn", and
• "notifyMessage" for all other NotifyTypes.

However, if you specify a messagePriority, it will determine the default rather than the actual NotifyType, if applyPriorityToAppearance is true.

Note that if RTL is active, the default will be as above, but with an "RTL" suffix added.

Parameters:

styleName - New styleName value. Default value is varies

Returns:

NotifySettings instance, for chaining setter calls

See Also:

setMessagePriority(int), CSSStyleName

getStyleName

public java.lang.String getStyleName()

The CSS class to apply to the Label drawn for this message. Default is:

• "notifyError" for NotifyType: "error",
• "notifyWarn" for NotifyType: "warn", and
• "notifyMessage" for all other NotifyTypes.

However, if you specify a messagePriority, it will determine the default rather than the actual NotifyType, if applyPriorityToAppearance is true.

Note that if RTL is active, the default will be as above, but with an "RTL" suffix added.

Returns:

Current styleName value. Default value is varies

See Also:

getMessagePriority(), CSSStyleName

setTopOffset

public NotifySettings setTopOffset(java.lang.Integer topOffset)

Specifies a top offset from the position specified by position or positionCanvas where the message should be shown. Ignored if coordinates are provided to position the message.

Parameters:

topOffset - New topOffset value. Default value is null

Returns:

NotifySettings instance, for chaining setter calls

See Also:

setPosition(com.smartgwt.client.types.EdgeName), setLeftOffset(java.lang.Integer)

getTopOffset

public java.lang.Integer getTopOffset()

Specifies a top offset from the position specified by position or positionCanvas where the message should be shown. Ignored if coordinates are provided to position the message.

Returns:

Current topOffset value. Default value is null

See Also:

getPosition(), getLeftOffset()

setX

public NotifySettings setX(java.lang.Integer x)

Where to show the message, as a viewport-relative x coordinate offset to the left edge of the Label rendering the message. Properties position and positionCanvas will only be used to place messages if coordinates aren't provided.

Parameters:

x - New x value. Default value is null

Returns:

NotifySettings instance, for chaining setter calls

See Also:

setY(java.lang.Integer), setPosition(com.smartgwt.client.types.EdgeName)

getX

public java.lang.Integer getX()

Where to show the message, as a viewport-relative x coordinate offset to the left edge of the Label rendering the message. Properties position and positionCanvas will only be used to place messages if coordinates aren't provided.

Returns:

Current x value. Default value is null

See Also:

getY(), getPosition()

setY

public NotifySettings setY(java.lang.Integer y)

Where to show the message, as a viewport-relative y coordinate offset to the top edge of the Label rendering the message.

Parameters:

y - New y value. Default value is null

Returns:

NotifySettings instance, for chaining setter calls

See Also:

setX(java.lang.Integer), setPosition(com.smartgwt.client.types.EdgeName)

getY

public java.lang.Integer getY()

Where to show the message, as a viewport-relative y coordinate offset to the top edge of the Label rendering the message.

Returns:

Current y value. Default value is null

See Also:

getX(), getPosition()