com.github.gwtbootstrap.client.ui

Class Collapse

java.lang.Object

com.github.gwtbootstrap.client.ui.base.MarkupWidget

com.github.gwtbootstrap.client.ui.Collapse

All Implemented Interfaces:

HasId, HasVisibility, HasVisibleHandlers, AcceptsOneWidget, HasOneWidget, HasWidgets, IsWidget, Iterable<Widget>

public class Collapse
extends MarkupWidget
implements HasVisibility, HasVisibleHandlers

Markup widget of Collapse

It's a markup widget (decorator widget). it's can exchange child to Collapsible widget. It's need trigger, You have 2 ways to create trigger.

1. Using CollapseTrigger.
2. Calling toggle().

UiBinder Usage:

 <b:Collapse b:id="toggle1" defaultOpen="true">
   <!-- it can be added any widget, but accept one wdiget.
   <b:Label>aaa</b:Label>
 </b:Collapse>
 
 

Since:

2.2.1.0

Author:

ohashi keisuke

See Also:

Accordion, Collapse, CollapseTrigger, Twitter Bootstrap document

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

HasWidgets.ForIsWidget

Field Summary

Fields inherited from class com.github.gwtbootstrap.client.ui.base.MarkupWidget

widget

Constructor Summary

Constructors

Constructor and Description
Collapse()

Method Summary

Methods

Modifier and Type	Method and Description
HandlerRegistration	addHiddenHandler(HiddenHandler handler) Adds a HiddenEvent handler.
HandlerRegistration	addHideHandler(HideHandler handler) Adds a HideEvent handler.
HandlerRegistration	addShowHandler(ShowHandler handler) Adds a ShowEvent handler.
HandlerRegistration	addShownHandler(ShownHandler handler) Adds a ShownEvent handler.
Widget	asWidget()
protected void	changeVisibility(Element e, String c)
protected void	changeVisibility(Element e, String visibility, boolean autoTriggered)
static void	changeVisibility(String target, String c)
static void	changeVisibility(String target, String c, boolean autoTriggered)
protected void	changeVisibility(VisibilityChange visibilityChange) Change visibility
protected void	changeVisibility(VisibilityChange visibilityChange, boolean autoTriggered)
void	configure(Element e, String parent, boolean toggle) Configure collapse settings.
static void	configure(String selector, String parent, boolean toggle) Configure collapse settings.
String	getParent() Get parent selector
void	hide() Hides the widget if it was previously shown.
void	hide(boolean autoHidden)
boolean	isExistTrigger() Is exist Trigger?
boolean	isToggle() is the collapsible element toggled on invocation
protected void	onHidden(Event e) This method is called once the widget is completely hidden.
protected void	onHide(Event e) This method is called immediately when the widget's hide() method is executed.
protected void	onShow(Event e) This method is called immediately when the widget's show() method is executed.
protected void	onShown(Event e) This method is called once the widget is completely shown.
void	reconfigure() re configure setting
protected void	removeDataIfExists(Element e) Remove data api.
void	setDefaultOpen(boolean dafaultOpen)
void	setExistTrigger(boolean existTrigger) Is there the trigger(Collapse Trigger)
protected void	setHandlerFunctions(Element e) Links the Java functions that fire the events.
void	setParent(String parent) Set parent selector.
void	setToggle(boolean toggle) Toggles the collapsible element on invocation
void	setWidget(Widget w)
void	show() Shows the widget if it was previously hidden.
void	show(boolean autoShown)
void	toggle() Toggles the view state of the widget.

Methods inherited from class com.github.gwtbootstrap.client.ui.base.MarkupWidget

add, add, clear, getId, getWidget, iterator, remove, setId, setWidget

Methods inherited from class java.lang.Object

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

Constructor Detail

Collapse

public Collapse()

Method Detail

getParent

public String getParent()

Get parent selector

Returns:

parent parent selector

setParent

public void setParent(String parent)

Set parent selector. it only work with AccordionGroup, Please see this issue.

Parameters:

parent - parent selector

isToggle

public boolean isToggle()

is the collapsible element toggled on invocation

Returns:

toggle true:toggled , false: un-toggled

setToggle

public void setToggle(boolean toggle)

Toggles the collapsible element on invocation

Parameters:

toggle - true: toggled on invocation , false : not-toggled

setDefaultOpen

public void setDefaultOpen(boolean dafaultOpen)

asWidget

public Widget asWidget()

Specified by:

asWidget in interface IsWidget

Overrides:

asWidget in class MarkupWidget

setWidget

public void setWidget(Widget w)

Specified by:

setWidget in interface HasOneWidget

Overrides:

setWidget in class MarkupWidget

addHideHandler

public HandlerRegistration addHideHandler(HideHandler handler)

Adds a HideEvent handler.

Specified by:

addHideHandler in interface HasVisibleHandlers

Parameters:

handler - the hide handler

Returns:

HandlerRegistration used to remove this handler

addHiddenHandler

public HandlerRegistration addHiddenHandler(HiddenHandler handler)

Adds a HiddenEvent handler.

Specified by:

addHiddenHandler in interface HasVisibleHandlers

Parameters:

handler - the hidden handler

Returns:

HandlerRegistration used to remove this handler

addShowHandler

public HandlerRegistration addShowHandler(ShowHandler handler)

Adds a ShowEvent handler.

Specified by:

addShowHandler in interface HasVisibleHandlers

Parameters:

handler - the show handler

Returns:

HandlerRegistration used to remove this handler

addShownHandler

public HandlerRegistration addShownHandler(ShownHandler handler)

Adds a ShownEvent handler.

Specified by:

addShownHandler in interface HasVisibleHandlers

Parameters:

handler - the shown handler

Returns:

HandlerRegistration used to remove this handler

show

public void show(boolean autoShown)

show

public void show()

Shows the widget if it was previously hidden.

Specified by:

show in interface HasVisibility

hide

public void hide()

Hides the widget if it was previously shown.

Specified by:

hide in interface HasVisibility

hide

public void hide(boolean autoHidden)

toggle

public void toggle()

Toggles the view state of the widget.

It will be hidden if it was previously shown and shown if it was previously hidden.

Specified by:

toggle in interface HasVisibility

changeVisibility

protected void changeVisibility(VisibilityChange visibilityChange)

Change visibility

Parameters:

visibilityChange - call method

changeVisibility

protected void changeVisibility(VisibilityChange visibilityChange,
                    boolean autoTriggered)

isExistTrigger

public boolean isExistTrigger()

Is exist Trigger?

Returns:

existTrigger

setExistTrigger

public void setExistTrigger(boolean existTrigger)

Is there the trigger(Collapse Trigger)

Parameters:

existTrigger - exists:true, none:false

reconfigure

public void reconfigure()

re configure setting

configure

public void configure(Element e,
             String parent,
             boolean toggle)

Configure collapse settings.

Parameters:

e - element

parent - parent selector

toggle - is toggled on added document

configure

public static void configure(String selector,
             String parent,
             boolean toggle)

Configure collapse settings.

Parameters:

selector - selector

parent - parent selector

toggle - is toggled on added document

removeDataIfExists

protected void removeDataIfExists(Element e)

Remove data api.

Parameters:

e - element

setHandlerFunctions

protected void setHandlerFunctions(Element e)

Links the Java functions that fire the events.

changeVisibility

protected void changeVisibility(Element e,
                    String c)

changeVisibility

protected void changeVisibility(Element e,
                    String visibility,
                    boolean autoTriggered)

changeVisibility

public static void changeVisibility(String target,
                    String c)

changeVisibility

public static void changeVisibility(String target,
                    String c,
                    boolean autoTriggered)

onHide

protected void onHide(Event e)

This method is called immediately when the widget's hide() method is executed.

onHidden

protected void onHidden(Event e)

This method is called once the widget is completely hidden.

onShow

protected void onShow(Event e)

This method is called immediately when the widget's show() method is executed.

onShown

protected void onShown(Event e)

This method is called once the widget is completely shown.