| com.gwtext.client.widgets.Component
 com.gwtext.client.widgets.Button
com.gwtext.client.widgets.SplitButton
com.gwtext.client.widgets.CycleButton
| CycleButton | | public class CycleButton extends SplitButton (Code) | | A specialized SplitButton that contains a menu of
CheckItem elements. The button automatically cycles through
each menu item on click, raising the button's change event (or calling the button's changeHandler function, if supplied)
for the active menu item. Clicking on the arrow section of the button displays the dropdown menu just like a normal SplitButton.
CycleButtonConfig config = new CycleButtonConfig();
config.setShowText(true);
config.setPrependText("View as ");
config.addItem(new CheckItem("text only", true));
config.addItem(new CheckItem("HTML", false));
config.setChangeHandler(new CycleButtonHandler() {
public void execute(CycleButton self, CheckItem item) {
MessageBox.alert("Change View", item.getText());
}
});
CycleButton button = new CycleButton(config);
|
| Method Summary | |
| public void | addItem(CheckItem item)
Add a CheckItem config object to be used when creating the button's menu items. | | native public void | addListener(CycleButtonListener listener)
Add a CycleButton Listener. | | native protected JavaScriptObject | create(JavaScriptObject config)
| | native public CheckItem | getActiveItem()
Gets the currently active menu item. | | public String | getPrependText()
| | public String | getShowText()
| | public String | getXType()
| | native public void | setActiveItem(CheckItem item)
Sets the button's active menu item. | | native public void | setActiveItem(CheckItem item, boolean supressEvent)
Sets the button's active menu item. | | public void | setPrependText(String prependText)
A static string to prepend before the active item's text when displayed as the button's text
(only applies when showText = true, defaults to ''). | | public void | setShowText(boolean showText)
True to display the active item's text as the button text (defaults to false). | | native public void | toggleSelected()
This is normally called internally on button click, but can be called externally to advance the button's active
item programmatically to the next one in the menu. |
| CycleButton | | public CycleButton()(Code) | | Create a new CycleButton.
|
| CycleButton | | public CycleButton(CycleButtonListener listener)(Code) | | Create a new CycleButton.
Parameters:
listener - the button listener |
| CycleButton | | public CycleButton(CycleButtonListener listener, String icon)(Code) | | Create a new CycleButton.
Parameters:
listener - the button listener
Parameters:
icon - icon image path |
| CycleButton | | public CycleButton(JavaScriptObject jsObj)(Code) | | |
| addItem | | public void addItem(CheckItem item) throws IllegalStateException(Code) | | Add a CheckItem config object to be used when creating the button's menu items.
Parameters:
item - check item config
throws:
IllegalStateException - this property cannot be changed after the Component has been rendered |
| addListener | | native public void addListener(CycleButtonListener listener)(Code) | | Add a CycleButton Listener.
Parameters:
listener - the listener |
| create | | native protected JavaScriptObject create(JavaScriptObject config)(Code) | | |
| getActiveItem | | native public CheckItem getActiveItem()(Code) | | Gets the currently active menu item.
the active menu item |
| getPrependText | | public String getPrependText()(Code) | | the prepend text |
| setActiveItem | | native public void setActiveItem(CheckItem item)(Code) | | Sets the button's active menu item.
Parameters:
item - the item to activate |
| setActiveItem | | native public void setActiveItem(CheckItem item, boolean supressEvent)(Code) | | Sets the button's active menu item.
Parameters:
item - the item to activate
Parameters:
supressEvent - true to prevent the button's change event from firing (defaults to false) |
| setPrependText | | public void setPrependText(String prependText)(Code) | | A static string to prepend before the active item's text when displayed as the button's text
(only applies when showText = true, defaults to '').
Parameters:
prependText - the prepend text |
| setShowText | | public void setShowText(boolean showText)(Code) | | True to display the active item's text as the button text (defaults to false).
Parameters:
showText - true to display item's text |
| toggleSelected | | native public void toggleSelected()(Code) | | This is normally called internally on button click, but can be called externally to advance the button's active
item programmatically to the next one in the menu. If the current item is the last one in the menu the active item
will be set to the first item in the menu.
|
| Methods inherited from com.gwtext.client.widgets.Component | public void addClass(String cls)(Code)(Java Doc)
native public void addClassCreated(String cls)(Code)(Java Doc)
native public void addEvent(String events)(Code)(Java Doc)
public void addEvents(String[] events)(Code)(Java Doc)
protected void addListener(String event, JavaScriptObject fn)(Code)(Java Doc)
native public void addListener(String event, Function funtion)(Code)(Java Doc)
native protected void addListener(ComponentListener listener)(Code)(Java Doc)
protected void afterRender()(Code)(Java Doc)
protected void beforeDestroy()(Code)(Java Doc)
protected void check() throws IllegalStateException(Code)(Java Doc)
public Component cloneComponent()(Code)(Java Doc)
public Component cloneComponent(Component overrides)(Code)(Java Doc)
native protected JavaScriptObject cloneConfig(JavaScriptObject config)(Code)(Java Doc)
abstract protected JavaScriptObject create(JavaScriptObject config)(Code)(Java Doc)
native public void destroy()(Code)(Java Doc)
public void disable()(Code)(Java Doc)
public void enable()(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void error(String message) throws IllegalStateException(Code)(Java Doc)
public void focus()(Code)(Java Doc)
native public void focus(boolean selectText)(Code)(Java Doc)
native public void focus(boolean selectText, int delay)(Code)(Java Doc)
public Element getApplyTo()(Code)(Java Doc)
protected String getAttribute(String attribute)(Code)(Java Doc)
protected boolean getAttributeAsBoolean(String attribute)(Code)(Java Doc)
protected float getAttributeAsFloat(String attribute)(Code)(Java Doc)
protected int getAttributeAsInt(String attribute)(Code)(Java Doc)
protected JavaScriptObject getAttributeAsJavaScriptObject(String attribute)(Code)(Java Doc)
public boolean getAutoShow()(Code)(Java Doc)
public String getCls()(Code)(Java Doc)
native protected static JavaScriptObject getComponentJS(String id)(Code)(Java Doc)
public JavaScriptObject getConfig()(Code)(Java Doc)
abstract protected JavaScriptObject getConfigPrototype()(Code)(Java Doc)
public String getCtCls()(Code)(Java Doc)
public String getDisabledClass()(Code)(Java Doc)
native public ExtElement getEl()(Code)(Java Doc)
native protected Element getElement(JavaScriptObject jsObj)(Code)(Java Doc)
public Element getElement()(Code)(Java Doc)
public String getHideMode()(Code)(Java Doc)
public boolean getHideParent()(Code)(Java Doc)
public String getId()(Code)(Java Doc)
native public String getItemId()(Code)(Java Doc)
public JavaScriptObject getJsObj()(Code)(Java Doc)
public int getOffsetHeight()(Code)(Java Doc)
public int getOffsetWidth()(Code)(Java Doc)
public JavaScriptObject getOrCreateJsObj()(Code)(Java Doc)
native public Container getOwnerContainer()(Code)(Java Doc)
public Element getRenderTo()(Code)(Java Doc)
public String[] getStateEvents()(Code)(Java Doc)
public String getStateId()(Code)(Java Doc)
public String getStyle()(Code)(Java Doc)
protected Element getStyleElement()(Code)(Java Doc)
public String getTitle()(Code)(Java Doc)
public String getXType()(Code)(Java Doc)
native public String getXTypes()(Code)(Java Doc)
public int hashCode()(Code)(Java Doc)
public void hide()(Code)(Java Doc)
protected void initComponent()(Code)(Java Doc)
public boolean isCreated()(Code)(Java Doc)
public boolean isDisabled()(Code)(Java Doc)
public boolean isHidden()(Code)(Java Doc)
native public boolean isRendered()(Code)(Java Doc)
native public boolean isVisible()(Code)(Java Doc)
native public boolean isXType(String xtype)(Code)(Java Doc)
native public boolean isXType(String xtype, boolean shallow)(Code)(Java Doc)
protected void onDestroy()(Code)(Java Doc)
native public void removeClass(String cls)(Code)(Java Doc)
native public void render(String id)(Code)(Java Doc)
native public void render(String id, String position)(Code)(Java Doc)
native public void render(String id, int position)(Code)(Java Doc)
native public void render(Element element)(Code)(Java Doc)
native public void render(Element element, String position)(Code)(Java Doc)
native public void render(Element element, int position)(Code)(Java Doc)
public void setApplyTo(Element element) throws IllegalStateException(Code)(Java Doc)
protected void setAttribute(String attribute, String value, boolean allowPostCreate)(Code)(Java Doc)
protected void setAttribute(String attribute, String value, boolean allowPostCreate, boolean allowPostRendered)(Code)(Java Doc)
protected void setAttribute(String attribute, int[] value, boolean allowPostCreate)(Code)(Java Doc)
protected void setAttribute(String attribute, int[] value, boolean allowPostCreate, boolean allowPostRender)(Code)(Java Doc)
protected void setAttribute(String attribute, long value, boolean allowPostCreate)(Code)(Java Doc)
protected void setAttribute(String attribute, double value, boolean allowPostCreate)(Code)(Java Doc)
protected void setAttribute(String attribute, int value, boolean allowPostCreate)(Code)(Java Doc)
protected void setAttribute(String attribute, int value, boolean allowPostCreate, boolean allowPostRender)(Code)(Java Doc)
protected void setAttribute(String attribute, Date value, boolean allowPostCreate)(Code)(Java Doc)
protected void setAttribute(String attribute, JavaScriptObject value, boolean allowPostCreate)(Code)(Java Doc)
protected void setAttribute(String attribute, JavaScriptObject value, boolean allowPostCreate, boolean allowPostRender)(Code)(Java Doc)
protected void setAttribute(String attribute, String[] value, boolean allowPostCreate)(Code)(Java Doc)
protected void setAttribute(String attribute, String[] value, boolean allowPostCreate, boolean allowPostRender)(Code)(Java Doc)
protected void setAttribute(String attribute, boolean value, boolean allowPostCreate)(Code)(Java Doc)
protected void setAttribute(String attribute, boolean value, boolean allowPostCreate, boolean allowPostRendered)(Code)(Java Doc)
protected void setAttribute(String attribute, Element value, boolean allowPostCreate)(Code)(Java Doc)
protected void setAttribute(String attribute, Element value, boolean allowPostCreate, boolean allowPostRendered)(Code)(Java Doc)
public void setAutoEl(String autoEl)(Code)(Java Doc)
public void setAutoShow(boolean autoShow) throws IllegalStateException(Code)(Java Doc)
public void setCls(String cls)(Code)(Java Doc)
public void setCtCls(String ctCls) throws IllegalStateException(Code)(Java Doc)
public void setDisabled(boolean disabled)(Code)(Java Doc)
public void setDisabledClass(String disabledClass)(Code)(Java Doc)
public void setEl(Element el) throws IllegalStateException(Code)(Java Doc)
public void setEl(String elementID) throws IllegalStateException(Code)(Java Doc)
public void setHeight(String height)(Code)(Java Doc)
public void setHideMode(String hideMode)(Code)(Java Doc)
public void setHideParent(boolean hideParent) throws IllegalStateException(Code)(Java Doc)
final public void setId(String id) throws IllegalStateException(Code)(Java Doc)
public void setRenderTo(Element elem) throws IllegalStateException(Code)(Java Doc)
public void setStateEvents(String[] stateEvents) throws IllegalStateException(Code)(Java Doc)
public void setStateId(String stateId) throws IllegalStateException(Code)(Java Doc)
public void setStyle(String style) throws IllegalStateException(Code)(Java Doc)
public void setTitle(String title)(Code)(Java Doc)
public void setVisible(boolean visible)(Code)(Java Doc)
public void setWidth(String width)(Code)(Java Doc)
public void show()(Code)(Java Doc)
|
|
|