public class NotifySettings extends DataClass
Notify.addMessage() are drawn and behave.factoryCreated, factoryProperties| Constructor and Description |
|---|
NotifySettings() |
NotifySettings(com.google.gwt.core.client.JavaScriptObject jsObj) |
| 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()
|
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)
|
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. |
applyFactoryProperties, doAddHandler, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsDoubleArray, 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, setFactoryCreatedpublic NotifySettings()
public NotifySettings(com.google.gwt.core.client.JavaScriptObject jsObj)
public static NotifySettings getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public NotifySettings setActionSeparator(java.lang.String actionSeparator)
You may override this on a per action basis using NotifyAction.separator.
Besides the default, some other known useful values are " " and " ".
actionSeparator - New actionSeparator value. Default value is " "NotifySettings instance, for chaining setter callsHTMLStringpublic java.lang.String getActionSeparator()
You may override this on a per action basis using NotifyAction.separator.
Besides the default, some other known useful values are " " and " ".
HTMLStringpublic NotifySettings setActionStyleName(java.lang.String actionStyleName)
NotifyType: "error", NotifyType: "warn", and NotifyTypes. messagePriority, it will determine the default
rather than the actual NotifyType, if applyPriorityToAppearance is true.actionStyleName - New actionStyleName value. Default value is variesNotifySettings instance, for chaining setter callssetMessagePriority(int),
CSSStyleNamepublic java.lang.String getActionStyleName()
NotifyType: "error", NotifyType: "warn", and NotifyTypes. messagePriority, it will determine the default
rather than the actual NotifyType, if applyPriorityToAppearance is true.getMessagePriority(),
CSSStyleNamepublic NotifySettings setAppearMethod(NotifyTransition appearMethod)
appearMethod - New appearMethod value. Default value is "slide"NotifySettings instance, for chaining setter callspublic NotifyTransition getAppearMethod()
public NotifySettings setApplyPriorityToAppearance(boolean applyPriorityToAppearance)
NotifyType corresponding to the messagePriority. Default is true except for
NotifyTypes "error" and "warn", which default to false.
Note : This is an advanced setting
applyPriorityToAppearance - New applyPriorityToAppearance value. Default value is variesNotifySettings instance, for chaining setter callssetMessagePriority(int)public boolean getApplyPriorityToAppearance()
NotifyType corresponding to the messagePriority. Default is true except for
NotifyTypes "error" and "warn", which default to false.getMessagePriority()public NotifySettings setAutoFitMaxWidth(java.lang.Integer autoFitMaxWidth)
autoFitWidth is enabled. May be specified as a pixel value, or a percentage of page width.autoFitMaxWidth - New autoFitMaxWidth value. Default value is 300NotifySettings instance, for chaining setter callssetAutoFitWidth(java.lang.Boolean)public java.lang.Integer getAutoFitMaxWidth()
autoFitWidth is enabled. May be specified as a pixel value, or a percentage of page width.getAutoFitWidth()public NotifySettings setAutoFitMaxWidth(java.lang.String autoFitMaxWidth)
autoFitWidth is enabled. May be specified as a pixel value, or a percentage of page width.autoFitMaxWidth - New autoFitMaxWidth value. Default value is 300NotifySettings instance, for chaining setter callssetAutoFitWidth(java.lang.Boolean)public java.lang.String getAutoFitMaxWidthAsString()
autoFitWidth is enabled. May be specified as a pixel value, or a percentage of page width.getAutoFitWidth()public NotifySettings setAutoFitWidth(java.lang.Boolean autoFitWidth)
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
autoFitWidth - New autoFitWidth value. Default value is nullNotifySettings instance, for chaining setter callspublic java.lang.Boolean getAutoFitWidth()
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.
public NotifySettings setCanDismiss(java.lang.Boolean canDismiss)
Notify.dismissMessage().canDismiss - New canDismiss value. Default value is falseNotifySettings instance, for chaining setter callspublic java.lang.Boolean getCanDismiss()
Notify.dismissMessage().public NotifySettings setDisappearMethod(NotifyTransition disappearMethod)
disappearMethod - New disappearMethod value. Default value is "fade"NotifySettings instance, for chaining setter callspublic NotifyTransition getDisappearMethod()
public NotifySettings setDuration(int duration)
Notify.dismissMessage() or, if canDismiss is set, by performing a "close click".duration - New duration value. Default value is 5000NotifySettings instance, for chaining setter callspublic int getDuration()
Notify.dismissMessage() or, if canDismiss is set, by performing a "close click".public NotifySettings setFadeInDuration(int fadeInDuration)
NotifyTransition: "fade", in milliseconds.fadeInDuration - New fadeInDuration value. Default value is 500NotifySettings instance, for chaining setter callspublic int getFadeInDuration()
NotifyTransition: "fade", in milliseconds.public NotifySettings setFadeOutDuration(int fadeOutDuration)
NotifyTransition: "fade", in
milliseconds.fadeOutDuration - New fadeOutDuration value. Default value is 500NotifySettings instance, for chaining setter callspublic int getFadeOutDuration()
NotifyTransition: "fade", in
milliseconds.public NotifySettings setLabelProperties(Label labelProperties)
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. |
labelProperties - New labelProperties value. Default value is nullNotifySettings instance, for chaining setter callsSGWTPropertiespublic Label getLabelProperties()
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. |
public NotifySettings setLeftOffset(java.lang.Integer leftOffset)
position or positionCanvas where the message should be shown.
Ignored if coordinates are provided to position the
message.leftOffset - New leftOffset value. Default value is nullNotifySettings instance, for chaining setter callssetPosition(com.smartgwt.client.types.EdgeName),
setTopOffset(java.lang.Integer)public java.lang.Integer getLeftOffset()
position or positionCanvas where the message should be shown.
Ignored if coordinates are provided to position the
message.getPosition(),
getTopOffset()public NotifySettings setMaxStackDismissMode(MaxStackDismissMode maxStackDismissMode)
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.
maxStackDismissMode - New maxStackDismissMode value. Default value is "oldest"NotifySettings instance, for chaining setter callssetDuration(int),
Notify.dismissMessage(com.smartgwt.client.widgets.notify.MessageID)public MaxStackDismissMode getMaxStackDismissMode()
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.
getDuration(),
Notify.dismissMessage(com.smartgwt.client.widgets.notify.MessageID)public NotifySettings setMaxStackSize(int maxStackSize)
MultiMessageMode is "stack". The
oldest message of the affected NotifyType will be dismissed to enforce this limit.maxStackSize - New maxStackSize value. Default value is 3NotifySettings instance, for chaining setter callspublic int getMaxStackSize()
MultiMessageMode is "stack". The
oldest message of the affected NotifyType will be dismissed to enforce this limit.public NotifySettings setMessageControlPadding(java.lang.Integer messageControlPadding)
dismiss button so that the button doesn't occlude any
content. Only needed if the message styling
doesn't already provide enough padding.messageControlPadding - New messageControlPadding value. Default value is nullNotifySettings instance, for chaining setter callspublic java.lang.Integer getMessageControlPadding()
dismiss button so that the button doesn't occlude any
content. Only needed if the message styling
doesn't already provide enough padding.public NotifySettings setMessageIcon(java.lang.String messageIcon)
Label drawn for this message. Default is NotifyType: "error", NotifyType: "warn", and NotifyTypes. messagePriority, it will determine the default
rather than the actual NotifyType, if applyPriorityToAppearance is true.messageIcon - New messageIcon value. Default value is variesNotifySettings instance, for chaining setter callssetMessagePriority(int),
SCImgURLpublic java.lang.String getMessageIcon()
Label drawn for this message. Default is NotifyType: "error", NotifyType: "warn", and NotifyTypes. messagePriority, it will determine the default
rather than the actual NotifyType, if applyPriorityToAppearance is true.getMessagePriority(),
SCImgURLpublic NotifySettings setMessageIconHeight(int messageIconHeight)
messageIconHeight - New messageIconHeight value. Default value is 17NotifySettings instance, for chaining setter callsLabel.setIconHeight(java.lang.Integer)public int getMessageIconHeight()
Label.getIconHeight()public NotifySettings setMessageIconOrientation(java.lang.String messageIconOrientation)
"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.
messageIconOrientation - New messageIconOrientation value. Default value is variesNotifySettings instance, for chaining setter callsLabel.setIconAlign(java.lang.String),
Label.setIconOrientation(java.lang.String)public java.lang.String getMessageIconOrientation()
"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.
Label.getIconAlign(),
Label.getIconOrientation()public NotifySettings setMessageIconSpacing(int messageIconSpacing)
messageIconSpacing - New messageIconSpacing value. Default value is 20NotifySettings instance, for chaining setter callsLabel.setIconSpacing(int)public int getMessageIconSpacing()
Label.getIconSpacing()public NotifySettings setMessageIconWidth(int messageIconWidth)
messageIconWidth - New messageIconWidth value. Default value is 17NotifySettings instance, for chaining setter callsLabel.setIconWidth(java.lang.Integer)public int getMessageIconWidth()
Label.getIconWidth()public NotifySettings setMessagePriority(int messagePriority)
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 If you specify
messagePriority, and applyPriorityToAppearance is set, the properties:
NotifyType: "error" for priority ERROR, NotifyType: "warn" for
priority WARN, or NotifyType: "message" for priorities at or below MESSAGE (greater or equal numerically) NotifyType by simply supplying a messagePriority for that message.
Note : This is an advanced setting
messagePriority - New messagePriority value. Default value is variesNotifySettings instance, for chaining setter callsNotify.addMessage(java.lang.String),
setMaxStackDismissMode(com.smartgwt.client.types.MaxStackDismissMode)public int getMessagePriority()
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 If you specify
messagePriority, and applyPriorityToAppearance is set, the properties:
NotifyType: "error" for priority ERROR, NotifyType: "warn" for
priority WARN, or NotifyType: "message" for priorities at or below MESSAGE (greater or equal numerically) NotifyType by simply supplying a messagePriority for that message.Notify.addMessage(java.lang.String),
getMaxStackDismissMode()public NotifySettings setMultiMessageMode(MultiMessageMode multiMessageMode)
NotifyType being shown. Such messages are either stacked or replace one another,multiMessageMode - New multiMessageMode value. Default value is "stack"NotifySettings instance, for chaining setter callspublic MultiMessageMode getMultiMessageMode()
NotifyType being shown. Such messages are either stacked or replace one another,public NotifySettings setPosition(EdgeName position)
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.
position - New position value. Default value is variesNotifySettings instance, for chaining setter callssetX(java.lang.Integer),
setY(java.lang.Integer),
setPositionCanvas(com.smartgwt.client.widgets.Canvas)public EdgeName getPosition()
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.
getX(),
getY(),
getPositionCanvas()public NotifySettings setPositionCanvas(Canvas positionCanvas)
coordinates aren't provided. Note that the canvas is only used
to compute where to the place message, and will not be altered.positionCanvas - New positionCanvas value. Default value is nullNotifySettings instance, for chaining setter callssetLeftOffset(java.lang.Integer),
setTopOffset(java.lang.Integer),
setPosition(com.smartgwt.client.types.EdgeName)public Canvas getPositionCanvas()
coordinates aren't provided. Note that the canvas is only used
to compute where to the place message, and will not be altered.getLeftOffset(),
getTopOffset(),
getPosition()public NotifySettings setRepositionMethod(NotifyTransition repositionMethod)
Notify.setMessageContents() has been called. Valid values
are "slide" and "instant".repositionMethod - New repositionMethod value. Default value is "slide"NotifySettings instance, for chaining setter callspublic NotifyTransition getRepositionMethod()
Notify.setMessageContents() has been called. Valid values
are "slide" and "instant".public NotifySettings setSlideInOrigin(java.lang.String slideInOrigin)
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.
slideInOrigin - New slideInOrigin value. Default value is nullNotifySettings instance, for chaining setter callspublic java.lang.String getSlideInOrigin()
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.
public NotifySettings setSlideOutOrigin(java.lang.String slideOutOrigin)
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.
slideOutOrigin - New slideOutOrigin value. Default value is nullNotifySettings instance, for chaining setter callspublic java.lang.String getSlideOutOrigin()
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.
public NotifySettings setSlideSpeed(int slideSpeed)
NotifyTransition: "slide", in pixels/second.slideSpeed - New slideSpeed value. Default value is 300NotifySettings instance, for chaining setter callspublic int getSlideSpeed()
NotifyTransition: "slide", in pixels/second.public NotifySettings setStackDirection(StackDirection stackDirection)
MultiMessageMode is "stack". For example,
"down" means that older messages move down when a new message of the same NotifyType
appears.stackDirection - New stackDirection value. Default value is "down"NotifySettings instance, for chaining setter callspublic StackDirection getStackDirection()
MultiMessageMode is "stack". For example,
"down" means that older messages move down when a new message of the same NotifyType
appears.public NotifySettings setStackPersistence(StackPersistence stackPersistence)
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
stackPersistence - New stackPersistence value. Default value is "none"NotifySettings instance, for chaining setter callspublic StackPersistence getStackPersistence()
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.
public NotifySettings setStackSpacing(int stackSpacing)
MultiMessageMode is "stack".stackSpacing - New stackSpacing value. Default value is 2NotifySettings instance, for chaining setter callspublic int getStackSpacing()
MultiMessageMode is "stack".public NotifySettings setStayIfHovered(boolean stayIfHovered)
stayIfHovered - New stayIfHovered value. Default value is falseNotifySettings instance, for chaining setter callspublic boolean getStayIfHovered()
public NotifySettings setStyleName(java.lang.String styleName)
Label drawn for this message. Default is: NotifyType: "error", NotifyType: "warn", and NotifyTypes. 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.
styleName - New styleName value. Default value is variesNotifySettings instance, for chaining setter callssetMessagePriority(int),
CSSStyleNamepublic java.lang.String getStyleName()
Label drawn for this message. Default is: NotifyType: "error", NotifyType: "warn", and NotifyTypes. 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.
getMessagePriority(),
CSSStyleNamepublic NotifySettings setTopOffset(java.lang.Integer topOffset)
position or positionCanvas where the message should be shown.
Ignored if coordinates are provided to position the
message.topOffset - New topOffset value. Default value is nullNotifySettings instance, for chaining setter callssetPosition(com.smartgwt.client.types.EdgeName),
setLeftOffset(java.lang.Integer)public java.lang.Integer getTopOffset()
position or positionCanvas where the message should be shown.
Ignored if coordinates are provided to position the
message.getPosition(),
getLeftOffset()public NotifySettings setX(java.lang.Integer x)
Label rendering the message. Properties position and positionCanvas will only be used to place messages
if coordinates aren't provided.x - New x value. Default value is nullNotifySettings instance, for chaining setter callssetY(java.lang.Integer),
setPosition(com.smartgwt.client.types.EdgeName)public java.lang.Integer getX()
Label rendering the message. Properties position and positionCanvas will only be used to place messages
if coordinates aren't provided.getY(),
getPosition()public NotifySettings setY(java.lang.Integer y)
Label rendering the message.y - New y value. Default value is nullNotifySettings instance, for chaining setter callssetX(java.lang.Integer),
setPosition(com.smartgwt.client.types.EdgeName)public java.lang.Integer getY()
Label rendering the message.getX(),
getPosition()