org.gwtbootstrap3.extras.notify.client.ui.NotifySettings Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of gwtbootstrap3-extras Show documentation
Show all versions of gwtbootstrap3-extras Show documentation
Extra, third-party widgets/components for GwtBootstrap3
package org.gwtbootstrap3.extras.notify.client.ui;
/*
* #%L
* GwtBootstrap3
* %%
* Copyright (C) 2013 - 2015 GwtBootstrap3
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* #L%
*/
import org.gwtbootstrap3.extras.animate.client.ui.constants.Animation;
import org.gwtbootstrap3.extras.notify.client.constants.NotifyIconType;
import org.gwtbootstrap3.extras.notify.client.constants.NotifyPlacement;
import org.gwtbootstrap3.extras.notify.client.constants.NotifyPosition;
import org.gwtbootstrap3.extras.notify.client.constants.NotifyType;
import org.gwtbootstrap3.extras.notify.client.constants.NotifyUrlTarget;
import org.gwtbootstrap3.extras.notify.client.event.NotifyCloseHandler;
import org.gwtbootstrap3.extras.notify.client.event.NotifyClosedHandler;
import org.gwtbootstrap3.extras.notify.client.event.NotifyShowHandler;
import org.gwtbootstrap3.extras.notify.client.event.NotifyShownHandler;
import com.google.gwt.core.client.JavaScriptObject;
/**
* This class represent basic Notify's settings, that you can use to customize display of each Notify.
*
* You can also set current state as default for all new Notifies.
*
* @author jeffisenhart
* @author Sven Jacobs
* @author Joshua Godi
* @author Pavel Zlámal
* @author Xiaodong SUN
* @see #makeDefault()
*/
public class NotifySettings extends JavaScriptObject {
/**
* Default constructor
*/
protected NotifySettings() {}
/**
* Creates a new instance of {@link NotifySettings}.
*
* @return a new instance of {@link NotifySettings}.
*/
public static NotifySettings newSettings() {
return JavaScriptObject.createObject().cast();
}
/**
* Set element name or class or ID to append Notify to. Default is 'body'.
*
* @param element Name, class or ID
*/
public final native void setElement(String element) /*-{
this.element = element;
}-*/;
/**
* Set custom position to the Notify container element. Default is null.
*
* @param position one of STATIC, FIXED, RELATIVE, ABSOLUTE, or null
*/
public final void setPosition(final NotifyPosition position) {
setPosition((position != null) ? position.getPosition() : null);
}
/**
* Set native property of Notify's position.
*
* @param position Notify's position to the container element
*/
private final native void setPosition(String position) /*-{
this.position = position;
}-*/;
/**
* Set type of Notify (CSS style class name). Default is INFO.
*
* @param type one of INFO, WARNING, DANGER, SUCCESS
* @see NotifyType
*/
public final void setType(final NotifyType type) {
setType((type != null) ? type.getCssName() : NotifyType.INFO.getCssName());
}
/**
* Set custom style name to Notify. Resulting class name is "alert-[customType]".
*
* @param customType Style name to set
*/
public final native void setType(String customType) /*-{
this.type = customType;
}-*/;
/**
* If false, the data-notify="dismiss" element in
* the template will be hidden. Default is true.
*
* @param allowDismiss if false, the close icon will be hidden
*/
public final native void setAllowDismiss(boolean allowDismiss) /*-{
this.allow_dismiss = allowDismiss;
}-*/;
/**
* If true, the notification should display a progress bar.
* Default is false.
*
* @param showProgressbar if true, the progress bar will be displayed
* @since 3.0.1
*/
public final native void setShowProgressbar(boolean showProgressbar) /*-{
this.showProgressbar = showProgressbar;
}-*/;
/**
* Set placement of Notify on screen. Default placement is {@link NotifyPlacement#TOP_RIGHT}.
*
* @param placement Notify's placement on screen
* @see NotifyPlacement
*/
public final void setPlacement(final NotifyPlacement placement) {
setNotifyPlacement((placement != null) ? placement : NotifyPlacement.TOP_RIGHT);
}
/**
* Set native property of Notify's placement.
*
* @param placement Notify's placement on screen
*/
private final native void setNotifyPlacement(final NotifyPlacement placement) /*-{
var from = placement.@org.gwtbootstrap3.extras.notify.client.constants.NotifyPlacement::getFrom()();
var align = placement.@org.gwtbootstrap3.extras.notify.client.constants.NotifyPlacement::getAlign()();
this.placement = { from: from, align: align };
}-*/;
/**
* If true, newer notifications push down older ones. Default
* is false.
*
* WARNING: Be careful when setting
* newestOnTop to true when a placement that
* already contains a notification has newest_on_top to
* false. It may cause issues with the plug-ins ability to
* place the notification in the correct location.
*
* @param newestOnTop if true, newer notifications push down older ones
* @since 3.0.0
*/
public final native void setNewestOnTop(boolean newestOnTop) /*-{
this.newest_on_top = newestOnTop;
}-*/;
/**
* Set offset (space between Notify and screen/browser edges) for each axis. Default is 20 PX for both.
*
* @param offX Offset for X axis in PX
* @param offY Offset for Y axis in PX
*/
public final native void setOffset(int offX, int offY) /*-{
this.offset = { x: offX, y: offY };
}-*/;
/**
* Set custom spacing between two Notifies. Default is 10 PX.
*
* @param space Spacing in PX
*/
public final native void setSpacing(int space) /*-{
this.spacing = space;
}-*/;
/**
* Set custom Z-index. Default is 1031.
*
* @param zIndex Z-index
*/
public final native void setZIndex(int zIndex) /*-{
this.z_index = zIndex;
}-*/;
/**
* Set delay, how long Notify stays on screen. Default is 5000 ms.
* Set to zero for unlimited time.
*
* @param mDelay Delay in milliseconds or zero for unlimited
*/
public final native void setDelay(int mDelay) /*-{
this.delay = mDelay;
}-*/;
/**
* Set timer. It's value is removed from remaining 'delay' on each 'timer' period.
* This way you can speed up hiding of Notify. If timer > remaining delay, Notify is
* hidden after delay runs out (ignoring timer).
*
* @param timer Time in milliseconds
* @see #setDelay(int)
*/
public final native void setTimer(int timer) /*-{
this.timer = timer;
}-*/;
/**
* Set custom URL target.
*
* Defaults to {@link NotifyUrlTarget#BLANK}.
*
* @param urlTarget URL target
*/
public final void setUrlTarget(NotifyUrlTarget urlTarget) {
setUrlTarget((urlTarget != null) ? urlTarget.getTarget() : NotifyUrlTarget.BLANK.getTarget());
}
/**
* Set custom URL target. Default is "_blank".
*
* See http://www.w3schools.com/tags/att_a_target.asp for possible values.
*
* @param customUrlTarget URL target
*/
public final native void setUrlTarget(String customUrlTarget) /*-{
this.url_target = customUrlTarget;
}-*/;
/**
* Pause countdown of display timeout when mouse is hovering above the Notify.
* Countdown continues (not restarted) if mouse leaves the Notify.
*
* @param pauseOnMouseOver TRUE = pause / FALSE = not pause
*/
public final native void setPauseOnMouseOver(boolean pauseOnMouseOver) /*-{
this.mouse_over = pauseOnMouseOver ? 'pause' : null;
}-*/;
/**
* Set Animation to Notify when it enters and exit the screen.
*
* Default is enter = Animation.FADE_IN_DOWN, exit = Animation.FADE_OUT_UP
*
* @see org.gwtbootstrap3.extras.animate.client.ui.constants.Animation
*
* @param enter animation style when Notify enters the screen
* @param exit animation style when Notify exists the screen
*/
public final void setAnimation(Animation enter, Animation exit) {
setAnimation((enter != null) ? enter.getCssName() : Animation.NO_ANIMATION.getCssName(),
(exit != null) ? exit.getCssName() : Animation.NO_ANIMATION.getCssName());
}
/**
* Set custom CSS style for animations of Notify when it enters and exits the screen.
* You must write your own CSS animation definition.
*
* @param enter animation style when Notify enters the screen
* @param exit animation style when Notify exists the screen
*/
public final native void setAnimation(String enter, String exit) /*-{
this.animate = { enter: enter, exit: exit };
}-*/;
/**
* Set the Notify's show event handler. The show event fires immediately when
* the show instance method is called.
*
* @param handler
*/
public final void setShowHandler(final NotifyShowHandler handler) {
onShow((handler != null) ? handler : NotifyShowHandler.DEFAULT_SHOW_HANDLER);
}
private final native void onShow(NotifyShowHandler handler) /*-{
this.onShow = function() {
handler.@org.gwtbootstrap3.extras.notify.client.event.NotifyShowHandler::onShow()();
};
}-*/;
/**
* Set the Notify's shown event handler. This event is fired when the modal has
* been made visible to the user (will wait for CSS transitions to complete).
*
* @param handler
*/
public final void setShownHandler(final NotifyShownHandler handler) {
onShown((handler != null) ? handler : NotifyShownHandler.DEFAULT_SHOWN_HANDLER);
}
private final native void onShown(NotifyShownHandler handler) /*-{
this.onShow = function() {
handler.@org.gwtbootstrap3.extras.notify.client.event.NotifyShownHandler::onShown()();
};
}-*/;
/**
* Set the Notify's close event handler. This event is fired immediately when
* the notification is closing.
*
* @param handler
*/
public final void setCloseHandler(final NotifyCloseHandler handler) {
onClose((handler != null) ? handler : NotifyCloseHandler.DEFAULT_CLOSE_HANDLER);
}
private final native void onClose(NotifyCloseHandler handler) /*-{
this.onClose = function() {
handler.@org.gwtbootstrap3.extras.notify.client.event.NotifyCloseHandler::onClose()();
};
}-*/;
/**
* Set the Notify's closed event handler. This event is fired when the modal
* has finished closing and is removed from the document (will wait for CSS
* transitions to complete).
*
* @param handler
*/
public final void setClosedHandler(final NotifyClosedHandler handler) {
onClosed((handler != null) ? handler : NotifyClosedHandler.DEFAULT_CLOSED_HANDLER);
}
private final native void onClosed(NotifyClosedHandler handler) /*-{
this.onClosed = function() {
handler.@org.gwtbootstrap3.extras.notify.client.event.NotifyClosedHandler::onClosed()();
};
}-*/;
/**
* Set icon type you will use for Notify. Default is 'class', which
* allows to use iconic fonts like FontAwesome.
* If you want to use images instead of class, set value to "image".
*
* Defaults to {@link NotifyIconType#CLASS}.
*
* @param iconType the icon type
* @see NotifyIconType
*/
public final void setIconType(NotifyIconType iconType) {
setIconType((iconType != null) ? iconType.getType() : NotifyIconType.CLASS.getType());
}
/**
* Set native property of Notify's icon type.
*
* @param iconType Notify's icon type.
*/
private final native void setIconType(String iconType) /*-{
this.icon_type = iconType;
}-*/;
/**
* Set custom HTML Template of Notify. Default value is:
*
*
* <div data-notify="container" class="col-xs-11 col-sm-3 alert alert-{0}" role="alert">
* <button type="button" aria-hidden="true" class="close" data-notify="dismiss">x</button>
* <span data-notify="icon"></span>
* <span data-notify="title">{1}</span>
* <span data-notify="message">{2}</span>
* <div class="progress" data-notify="progressbar">
* <div class="progress-bar progress-bar-{0}" role="progressbar" aria-valuenow="0" aria-valuemin="0" aria-valuemax="100" style="width: 0%;"></div>
* </div>
* <a href="{3}" target="{4}" data-notify="url"></a>
* </div>
*
*
* Where:
*
* - {0} = type
* - {1} = title
* - {2} = message
* - {3} = url
* - {4} = target
*
*
* @param html Custom HTML template
* @see documentation at: http://bootstrap-notify.remabledesigns.com/
*/
public final native void setTemplate(String html) /*-{
this.template = html;
}-*/;
/**
* Make this NotifySettings as default for all new Notifies.
*
* Values set to this NotifySettings overrides original default values.
* If value for some property is not set, original default value is kept.
*/
public final native void makeDefault() /*-{
$wnd.jQuery.notifyDefaults();
}-*/;
}