gwt.material.design.client.ui

Class MaterialPushpin

java.lang.Object

gwt.material.design.client.ui.MaterialPushpin

public class MaterialPushpin
extends Object

Pushpin is our fixed positioning plugin. You can check out our live examples: the fixed Table of Contents on the right.

UiBinder Usage:

 
 // CAN BE CALLED AS A HELPER STATIC CONTEXT
 MaterialPushpin.apply(target, source.getOffsetHeight() + 600);

 // INSTANTIATE THE PUSHPIN COMPONENT
 MaterialPushpin pushpin = new MaterialPushpin();
 pushpin.setWidget(source);
 pushpin.setTop(300.0);
 pushpin.setOffset(64.0);
 pushpin.setBottom(500.0);
 pushpin.apply();
 
 

Author:

kevzlou7979

See Also:

Material PushPin

Constructor Summary

Constructors

Constructor and Description
MaterialPushpin()

Method Summary

Modifier and Type	Method and Description
void	apply() Apply the pushpin feature into the target widget
static void	apply(com.google.gwt.user.client.ui.Widget widget, Double offset) A pushpinned element has 3 states.
static void	apply(com.google.gwt.user.client.ui.Widget widget, Double top, Double offset) A pushpinned element has 3 states.
static void	apply(com.google.gwt.user.client.ui.Widget widget, Double top, Double bottom, Double offset) A pushpinned element has 3 states.
Double	getBottom() Get the distance in pixels from the top of the page where the elements stops being fixed.
Double	getOffset() Get the offset from the top the element will be fixd at.
Double	getTop() Get the distance in pixels from the top of the page where the element becomes fixed.
com.google.gwt.user.client.ui.Widget	getWidget() Get the target widget which the pushpin was applied
void	setBottom(Double bottom) Set the distance in pixels from the top of the page where the elements stops being fixed.
void	setOffset(Double offset) Set the offset from the top the element will be fixed at.
void	setTop(Double top) Set the distance in pixels from the top of the page where the element becomes fixed.
void	setWidget(com.google.gwt.user.client.ui.Widget widget) Set the target widget to apply the pushpin feature

Methods inherited from class java.lang.Object

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

Constructor Detail

MaterialPushpin

public MaterialPushpin()

Method Detail

apply

public void apply()

Apply the pushpin feature into the target widget

apply

public static void apply(com.google.gwt.user.client.ui.Widget widget,
                         Double offset)

A pushpinned element has 3 states. One above and below the scrolling threshold, and the pinned state where the element becomes fixed.

Parameters:

widget - - Target widget to apply the pushpin feature

offset - - The offset from the top the element will be fixed at. (Default: 0)

apply

public static void apply(com.google.gwt.user.client.ui.Widget widget,
                         Double top,
                         Double offset)

A pushpinned element has 3 states. One above and below the scrolling threshold, and the pinned state where the element becomes fixed.

Parameters:

widget - - Target widget to apply the pushpin feature

top - - The distance in pixels from the top of the page where the element becomes fixed. (Default: 0)

offset - - The offset from the top the element will be fixed at. (Default: 0)

apply

public static void apply(com.google.gwt.user.client.ui.Widget widget,
                         Double top,
                         Double bottom,
                         Double offset)

A pushpinned element has 3 states. One above and below the scrolling threshold, and the pinned state where the element becomes fixed.

Parameters:

widget - - Target widget to apply the pushpin feature

top - - The distance in pixels from the top of the page where the element becomes fixed. (Default: 0)

bottom - - The distance in pixels from the top of the page where the elements stops being fixed. (Default: Infinity)

offset - - The offset from the top the element will be fixed at. (Default: 0)

getWidget

public com.google.gwt.user.client.ui.Widget getWidget()

Get the target widget which the pushpin was applied

setWidget

public void setWidget(com.google.gwt.user.client.ui.Widget widget)

Set the target widget to apply the pushpin feature

getOffset

public Double getOffset()

Get the offset from the top the element will be fixd at.

setOffset

public void setOffset(Double offset)

Set the offset from the top the element will be fixed at. (Default: 0)

getTop

public Double getTop()

Get the distance in pixels from the top of the page where the element becomes fixed. (Default: 0)

setTop

public void setTop(Double top)

Set the distance in pixels from the top of the page where the element becomes fixed. (Default: 0)

getBottom

public Double getBottom()

Get the distance in pixels from the top of the page where the elements stops being fixed. (Default: Infinity)

setBottom

public void setBottom(Double bottom)

Set the distance in pixels from the top of the page where the elements stops being fixed. (Default: Infinity)