package org.vaadin.smartgwt.server;
/*
* Smart GWT (GWT for SmartClient)
* Copyright 2008 and beyond, Isomorphic Software, Inc.
*
* Smart GWT is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License version 3
* as published by the Free Software Foundation. Smart GWT is also
* available under typical commercial license terms - see
* http://smartclient.com/license
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*/
import org.vaadin.smartgwt.server.types.Alignment;
import org.vaadin.smartgwt.server.types.SelectionType;
import org.vaadin.smartgwt.server.types.State;
import org.vaadin.smartgwt.server.types.VerticalAlignment;
import org.vaadin.smartgwt.server.util.EnumUtil;
/**
* A StretchImg that behaves like a button, going through up/down/over state transitions in response to user events.
* Supports an optional title, and will auto-size to accommodate the title text if <code>overflow</code> is set to
* "visible". <P> Examples of use include fancy buttons, poplist headers, and tabs.
*/
public class StretchImgButton extends StretchImg { // implements com.smartgwt.client.widgets.events.HasIconClickHandlers {
// public static StretchImgButton getOrCreateRef(JavaScriptObject jsObj) {
// if(jsObj == null) return null;
// BaseWidget obj = BaseWidget.getRef(jsObj);
// if(obj != null) {
// return (StretchImgButton) obj;
// } else {
// return new StretchImgButton(jsObj);
// }
// }
public StretchImgButton(){
scClassName = "StretchImgButton";
}
// public StretchImgButton(JavaScriptObject jsObj){
// super(jsObj);
// }
//
// protected native JavaScriptObject create()/*-{
// var config = this.@com.smartgwt.client.widgets.BaseWidget::getConfig()();
// var scClassName = this.@com.smartgwt.client.widgets.BaseWidget::scClassName;
// var widget = $wnd.isc[scClassName].create(config);
// this.@com.smartgwt.client.widgets.BaseWidget::doInit()();
// return widget;
// }-*/;
// ********************* Properties / Attributes ***********************
/**
* Behavior on state changes -- BUTTON, RADIO or CHECKBOX
*
* <br><br>If this method is called after the component has been drawn/initialized:
* Update the 'actionType' for this canvas (radio / checkbox / button) If the canvas is currently selected, and the passed in actionType is 'button' this method will deselect the canvas.
*
* @param actionType actionType Default value is "button"
* @see com.smartgwt.client.docs.State State overview and related methods
*/
public void setActionType(SelectionType actionType) {
setAttribute("actionType", actionType.getValue(), true);
}
/**
* Behavior on state changes -- BUTTON, RADIO or CHECKBOX
*
*
* @return Return the 'actionType' for this canvas (radio / checkbox / button)
* @see com.smartgwt.client.docs.State State overview and related methods
*/
public SelectionType getActionType() {
return EnumUtil.getEnum(SelectionType.values(), getAttribute("actionType"));
}
/**
* Horizontal alignment of this component's title.
*
* @param align align Default value is Canvas.CENTER
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
*/
public void setAlign(Alignment align) {
setAttribute("align", align.getValue(), true);
}
/**
* Horizontal alignment of this component's title.
*
*
* @return Alignment
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
*/
public Alignment getAlign() {
return EnumUtil.getEnum(Alignment.values(), getAttribute("align"));
}
/**
* If true, ignore the specified size of this widget and always size just large enough to accommodate the title. If
* <code>setWidth()</code> is explicitly called on an autoFit:true button, autoFit will be reset to <code>false</code>. <P>
* Note that for StretchImgButton instances, autoFit will occur horizontally only, as unpredictable vertical sizing is
* likely to distort the media. If you do want vertical auto-fit, this can be achieved by simply setting a small height,
* and having overflow:"visible"
*
* <br><br>If this method is called after the component has been drawn/initialized:
* Setter method for the {@link com.smartgwt.client.widgets.StatefulCanvas#getAutoFit autoFit} property. Pass in true or false to turn autoFit on or off. When autoFit is set to <code>false</code>, canvas will be resized to it's previously specified size.
*
* @param autoFit New autoFit setting.. Default value is null
* @see com.smartgwt.client.docs.Sizing Sizing overview and related methods
*/
public void setAutoFit(Boolean autoFit) {
setAttribute("autoFit", autoFit, true);
}
/**
* If true, ignore the specified size of this widget and always size just large enough to accommodate the title. If
* <code>setWidth()</code> is explicitly called on an autoFit:true button, autoFit will be reset to <code>false</code>. <P>
* Note that for StretchImgButton instances, autoFit will occur horizontally only, as unpredictable vertical sizing is
* likely to distort the media. If you do want vertical auto-fit, this can be achieved by simply setting a small height,
* and having overflow:"visible"
*
*
* @return Boolean
* @see com.smartgwt.client.docs.Sizing Sizing overview and related methods
*/
public Boolean getAutoFit() {
return getAttributeAsBoolean("autoFit");
}
/**
* Base CSS style. As the component changes state and/or is selected, suffixes will be added to the base style. <P> When
* the component changes state (eg becomes disabled), a suffix will be appended to this style name, reflecting the
* following states: "Over", "Down", or "Disabled". <P> If the widget is selected, the suffixes will be "Selected",
* "SelectedOver", etc. <P> If the widget has focus and {@link com.smartgwt.client.widgets.StatefulCanvas#getShowFocused
* showFocused} is true, and {@link com.smartgwt.client.widgets.StatefulCanvas#getShowFocusedAsOver showFocusedAsOver} is
* false, the suffixes will be "Focused", "FocusedOver", etc, or if the widget is both selected and focused,
* "SelectedFocused", "SelectedFocusedOver", etc. <P> For example, if <code>baseStyle</code> is set to "button", this
* component is {@link com.smartgwt.client.widgets.StretchImgButton#isSelected selected} and the mouse cursor is over this
* component, the style "buttonSelectedOver" will be used.
*
* <br><br>If this method is called after the component has been drawn/initialized:
* Sets the base CSS style. As the component changes state and/or is selected, suffixes will be added to the base style.
*
* @param baseStyle new base style. Default value is "stretchImgButton"
*/
public void setBaseStyle(String baseStyle) {
setAttribute("baseStyle", baseStyle, true);
}
/**
* Base CSS style. As the component changes state and/or is selected, suffixes will be added to the base style. <P> When
* the component changes state (eg becomes disabled), a suffix will be appended to this style name, reflecting the
* following states: "Over", "Down", or "Disabled". <P> If the widget is selected, the suffixes will be "Selected",
* "SelectedOver", etc. <P> If the widget has focus and {@link com.smartgwt.client.widgets.StatefulCanvas#getShowFocused
* showFocused} is true, and {@link com.smartgwt.client.widgets.StatefulCanvas#getShowFocusedAsOver showFocusedAsOver} is
* false, the suffixes will be "Focused", "FocusedOver", etc, or if the widget is both selected and focused,
* "SelectedFocused", "SelectedFocusedOver", etc. <P> For example, if <code>baseStyle</code> is set to "button", this
* component is {@link com.smartgwt.client.widgets.StretchImgButton#isSelected selected} and the mouse cursor is over this
* component, the style "buttonSelectedOver" will be used.
*
*
* @return String
*/
public String getBaseStyle() {
return getAttributeAsString("baseStyle");
}
/**
* How big are the end pieces by default
*
* @param capSize capSize Default value is 12
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
*/
public void setCapSize(int capSize) {
setAttribute("capSize", capSize, true);
}
/**
* How big are the end pieces by default
*
*
* @return int
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
*/
public int getCapSize() {
return getAttributeAsInt("capSize");
}
/**
* If set to true, if the {@link com.smartgwt.client.widgets.StatefulCanvas#getTitle title} of this button contains the
* specified {@link com.smartgwt.client.widgets.Canvas#getAccessKey accessKey}, when the title is displayed to the user it
* will be modified to include HTML to underline the accessKey.<br> Note that this property may cause titles that include
* HTML (rather than simple strings) to be inappropriately modified, so should be disabled if your title string includes
* HTML characters.
*
* @param hiliteAccessKey hiliteAccessKey Default value is true
*/
public void setHiliteAccessKey(Boolean hiliteAccessKey) {
setAttribute("hiliteAccessKey", hiliteAccessKey, true);
}
/**
* If set to true, if the {@link com.smartgwt.client.widgets.StatefulCanvas#getTitle title} of this button contains the
* specified {@link com.smartgwt.client.widgets.Canvas#getAccessKey accessKey}, when the title is displayed to the user it
* will be modified to include HTML to underline the accessKey.<br> Note that this property may cause titles that include
* HTML (rather than simple strings) to be inappropriately modified, so should be disabled if your title string includes
* HTML characters.
*
*
* @return Boolean
*/
public Boolean getHiliteAccessKey() {
return getAttributeAsBoolean("hiliteAccessKey");
}
/**
* Optional icon to be shown with the button title text. <P> Specify as the partial URL to an image, relative to the
* imgDir of this component.
*
* <br><br>If this method is called after the component has been drawn/initialized:
* Change the icon being shown next to the title text.
*
* @param icon URL of new icon. Default value is null
* @see com.smartgwt.client.docs.ButtonIcon ButtonIcon overview and related methods
*/
public void setIcon(String icon) {
setAttribute("icon", icon, true);
}
/**
* Optional icon to be shown with the button title text. <P> Specify as the partial URL to an image, relative to the
* imgDir of this component.
*
*
* @return String
* @see com.smartgwt.client.docs.ButtonIcon ButtonIcon overview and related methods
*/
// public String getIcon() {
// return getAttributeAsString("icon");
// }
/**
* If this button is showing an icon should it be right or left aligned?
*
* @param iconAlign iconAlign Default value is null
* @throws IllegalStateException this property cannot be changed after the component has been created
* @see com.smartgwt.client.docs.ButtonIcon ButtonIcon overview and related methods
*/
public void setIconAlign(String iconAlign) throws IllegalStateException {
setAttribute("iconAlign", iconAlign, false);
}
/**
* If this button is showing an icon should it be right or left aligned?
*
*
* @return String
* @see com.smartgwt.client.docs.ButtonIcon ButtonIcon overview and related methods
*/
public String getIconAlign() {
return getAttributeAsString("iconAlign");
}
/**
* Height in pixels of the icon image. <P> If unset, defaults to <code>iconSize</code>
*
* @param iconHeight iconHeight Default value is null
* @throws IllegalStateException this property cannot be changed after the component has been created
* @see com.smartgwt.client.docs.ButtonIcon ButtonIcon overview and related methods
*/
public void setIconHeight(Integer iconHeight) throws IllegalStateException {
setAttribute("iconHeight", iconHeight, false);
}
/**
* Height in pixels of the icon image. <P> If unset, defaults to <code>iconSize</code>
*
*
* @return Integer
* @see com.smartgwt.client.docs.ButtonIcon ButtonIcon overview and related methods
*/
public Integer getIconHeight() {
return getAttributeAsInt("iconHeight");
}
/**
* If this button is showing an icon should it appear to the left or right of the title? valid options are
* <code>"left"</code> and <code>"right"</code>.
*
* <br><br>If this method is called after the component has been drawn/initialized:
* Changes the orientation of the icon relative to the text of the button.
*
* @param iconOrientation The new orientation of the icon relative to the text of the button.. Default value is "left"
* @throws IllegalStateException this property cannot be changed after the component has been created
* @see com.smartgwt.client.docs.ButtonIcon ButtonIcon overview and related methods
*/
public void setIconOrientation(String iconOrientation) throws IllegalStateException {
setAttribute("iconOrientation", iconOrientation, false);
}
/**
* If this button is showing an icon should it appear to the left or right of the title? valid options are
* <code>"left"</code> and <code>"right"</code>.
*
*
* @return String
* @see com.smartgwt.client.docs.ButtonIcon ButtonIcon overview and related methods
*/
public String getIconOrientation() {
return getAttributeAsString("iconOrientation");
}
/**
* Size in pixels of the icon image. <P> The <code>iconWidth</code> and <code>iconHeight</code> properties can be used to
* configure width and height separately.
*
* @param iconSize iconSize Default value is 16
* @throws IllegalStateException this property cannot be changed after the component has been created
* @see com.smartgwt.client.docs.ButtonIcon ButtonIcon overview and related methods
*/
public void setIconSize(int iconSize) throws IllegalStateException {
setAttribute("iconSize", iconSize, false);
}
/**
* Size in pixels of the icon image. <P> The <code>iconWidth</code> and <code>iconHeight</code> properties can be used to
* configure width and height separately.
*
*
* @return int
* @see com.smartgwt.client.docs.ButtonIcon ButtonIcon overview and related methods
*/
public int getIconSize() {
return getAttributeAsInt("iconSize");
}
/**
* Pixels between icon and title text.
*
* @param iconSpacing iconSpacing Default value is 6
* @throws IllegalStateException this property cannot be changed after the component has been created
* @see com.smartgwt.client.docs.ButtonIcon ButtonIcon overview and related methods
*/
public void setIconSpacing(int iconSpacing) throws IllegalStateException {
setAttribute("iconSpacing", iconSpacing, false);
}
/**
* Pixels between icon and title text.
*
*
* @return int
* @see com.smartgwt.client.docs.ButtonIcon ButtonIcon overview and related methods
*/
public int getIconSpacing() {
return getAttributeAsInt("iconSpacing");
}
/**
* Width in pixels of the icon image. <P> If unset, defaults to <code>iconSize</code>
*
* @param iconWidth iconWidth Default value is null
* @throws IllegalStateException this property cannot be changed after the component has been created
* @see com.smartgwt.client.docs.ButtonIcon ButtonIcon overview and related methods
*/
public void setIconWidth(Integer iconWidth) throws IllegalStateException {
setAttribute("iconWidth", iconWidth, false);
}
/**
* Width in pixels of the icon image. <P> If unset, defaults to <code>iconSize</code>
*
*
* @return Integer
* @see com.smartgwt.client.docs.ButtonIcon ButtonIcon overview and related methods
*/
public Integer getIconWidth() {
return getAttributeAsInt("iconWidth");
}
/**
* The padding for a StretchImgButton's label is determined as follows. <P> If <code>labelHPad</code> is set it will
* specify the horizontal padding applied to the label. Similarly if <code>labelVPad</code> is set it will specify the
* vertical padding for the label, regardless of the button's {@link
* com.smartgwt.client.widgets.StretchImgButton#getVertical vertical} setting. <P> Otherwise <code>labelLengthPad</code>
* can be set to specify the label padding along the length axis (ie: horizontal padding if {@link
* com.smartgwt.client.widgets.StretchImgButton#getVertical vertical} is false, otherwise vertical padding), and
* <code>labelBreadthPad</code> can be set to specify the label padding along the other axis. <P> Otherwise the padding on
* the length axis will match the {@link com.smartgwt.client.widgets.StretchImgButton#getCapSize capSize} and will be set
* to zero on the breadth axis. <P> So by default the label will be sized to match the center image of the
* StretchImgButton, but these settings allow the label to partially or wholly overlap the caps.
*
* @param labelBreadthPad labelBreadthPad Default value is null
*/
public void setLabelBreadthPad(Integer labelBreadthPad) {
setAttribute("labelBreadthPad", labelBreadthPad, true);
}
/**
* The padding for a StretchImgButton's label is determined as follows. <P> If <code>labelHPad</code> is set it will
* specify the horizontal padding applied to the label. Similarly if <code>labelVPad</code> is set it will specify the
* vertical padding for the label, regardless of the button's {@link
* com.smartgwt.client.widgets.StretchImgButton#getVertical vertical} setting. <P> Otherwise <code>labelLengthPad</code>
* can be set to specify the label padding along the length axis (ie: horizontal padding if {@link
* com.smartgwt.client.widgets.StretchImgButton#getVertical vertical} is false, otherwise vertical padding), and
* <code>labelBreadthPad</code> can be set to specify the label padding along the other axis. <P> Otherwise the padding on
* the length axis will match the {@link com.smartgwt.client.widgets.StretchImgButton#getCapSize capSize} and will be set
* to zero on the breadth axis. <P> So by default the label will be sized to match the center image of the
* StretchImgButton, but these settings allow the label to partially or wholly overlap the caps.
*
*
* @return Integer
*/
public Integer getLabelBreadthPad() {
return getAttributeAsInt("labelBreadthPad");
}
/**
* The padding for a StretchImgButton's label is determined as follows. <P> If <code>labelHPad</code> is set it will
* specify the horizontal padding applied to the label. Similarly if <code>labelVPad</code> is set it will specify the
* vertical padding for the label, regardless of the button's {@link
* com.smartgwt.client.widgets.StretchImgButton#getVertical vertical} setting. <P> Otherwise <code>labelLengthPad</code>
* can be set to specify the label padding along the length axis (ie: horizontal padding if {@link
* com.smartgwt.client.widgets.StretchImgButton#getVertical vertical} is false, otherwise vertical padding), and
* <code>labelBreadthPad</code> can be set to specify the label padding along the other axis. <P> Otherwise the padding on
* the length axis will match the {@link com.smartgwt.client.widgets.StretchImgButton#getCapSize capSize} and will be set
* to zero on the breadth axis. <P> So by default the label will be sized to match the center image of the
* StretchImgButton, but these settings allow the label to partially or wholly overlap the caps.
*
* @param labelHPad labelHPad Default value is null
*/
public void setLabelHPad(Integer labelHPad) {
setAttribute("labelHPad", labelHPad, true);
}
/**
* The padding for a StretchImgButton's label is determined as follows. <P> If <code>labelHPad</code> is set it will
* specify the horizontal padding applied to the label. Similarly if <code>labelVPad</code> is set it will specify the
* vertical padding for the label, regardless of the button's {@link
* com.smartgwt.client.widgets.StretchImgButton#getVertical vertical} setting. <P> Otherwise <code>labelLengthPad</code>
* can be set to specify the label padding along the length axis (ie: horizontal padding if {@link
* com.smartgwt.client.widgets.StretchImgButton#getVertical vertical} is false, otherwise vertical padding), and
* <code>labelBreadthPad</code> can be set to specify the label padding along the other axis. <P> Otherwise the padding on
* the length axis will match the {@link com.smartgwt.client.widgets.StretchImgButton#getCapSize capSize} and will be set
* to zero on the breadth axis. <P> So by default the label will be sized to match the center image of the
* StretchImgButton, but these settings allow the label to partially or wholly overlap the caps.
*
*
* @return Integer
*/
public Integer getLabelHPad() {
return getAttributeAsInt("labelHPad");
}
/**
* The padding for a StretchImgButton's label is determined as follows. <P> If <code>labelHPad</code> is set it will
* specify the horizontal padding applied to the label. Similarly if <code>labelVPad</code> is set it will specify the
* vertical padding for the label, regardless of the button's {@link
* com.smartgwt.client.widgets.StretchImgButton#getVertical vertical} setting. <P> Otherwise <code>labelLengthPad</code>
* can be set to specify the label padding along the length axis (ie: horizontal padding if {@link
* com.smartgwt.client.widgets.StretchImgButton#getVertical vertical} is false, otherwise vertical padding), and
* <code>labelBreadthPad</code> can be set to specify the label padding along the other axis. <P> Otherwise the padding on
* the length axis will match the {@link com.smartgwt.client.widgets.StretchImgButton#getCapSize capSize} and will be set
* to zero on the breadth axis. <P> So by default the label will be sized to match the center image of the
* StretchImgButton, but these settings allow the label to partially or wholly overlap the caps.
*
* @param labelLengthPad labelLengthPad Default value is null
*/
public void setLabelLengthPad(Integer labelLengthPad) {
setAttribute("labelLengthPad", labelLengthPad, true);
}
/**
* The padding for a StretchImgButton's label is determined as follows. <P> If <code>labelHPad</code> is set it will
* specify the horizontal padding applied to the label. Similarly if <code>labelVPad</code> is set it will specify the
* vertical padding for the label, regardless of the button's {@link
* com.smartgwt.client.widgets.StretchImgButton#getVertical vertical} setting. <P> Otherwise <code>labelLengthPad</code>
* can be set to specify the label padding along the length axis (ie: horizontal padding if {@link
* com.smartgwt.client.widgets.StretchImgButton#getVertical vertical} is false, otherwise vertical padding), and
* <code>labelBreadthPad</code> can be set to specify the label padding along the other axis. <P> Otherwise the padding on
* the length axis will match the {@link com.smartgwt.client.widgets.StretchImgButton#getCapSize capSize} and will be set
* to zero on the breadth axis. <P> So by default the label will be sized to match the center image of the
* StretchImgButton, but these settings allow the label to partially or wholly overlap the caps.
*
*
* @return Integer
*/
public Integer getLabelLengthPad() {
return getAttributeAsInt("labelLengthPad");
}
/**
* Specifies a skinImgDir to apply to the label containing the title of this StretchImgButton. May be null in which case
* <code>this.skinImgDir</code> will be applied to the label as well. <P> Note that icons displayed in the title may make
* use of the skin img dir set here
*
* <br><br>If this method is called after the component has been drawn/initialized:
* setter for {@link com.smartgwt.client.widgets.StretchImgButton#getLabelSkinImgDir labelSkinImgDir}.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param labelSkinImgDir new skin img dir to apply to the label holding title text for this widget.. Default value is null
*/
public void setLabelSkinImgDir(String labelSkinImgDir) {
setAttribute("labelSkinImgDir", labelSkinImgDir, true);
}
/**
* Specifies a skinImgDir to apply to the label containing the title of this StretchImgButton. May be null in which case
* <code>this.skinImgDir</code> will be applied to the label as well. <P> Note that icons displayed in the title may make
* use of the skin img dir set here
*
*
* @return String
*/
public String getLabelSkinImgDir() {
return getAttributeAsString("labelSkinImgDir");
}
/**
* The padding for a StretchImgButton's label is determined as follows. <P> If <code>labelHPad</code> is set it will
* specify the horizontal padding applied to the label. Similarly if <code>labelVPad</code> is set it will specify the
* vertical padding for the label, regardless of the button's {@link
* com.smartgwt.client.widgets.StretchImgButton#getVertical vertical} setting. <P> Otherwise <code>labelLengthPad</code>
* can be set to specify the label padding along the length axis (ie: horizontal padding if {@link
* com.smartgwt.client.widgets.StretchImgButton#getVertical vertical} is false, otherwise vertical padding), and
* <code>labelBreadthPad</code> can be set to specify the label padding along the other axis. <P> Otherwise the padding on
* the length axis will match the {@link com.smartgwt.client.widgets.StretchImgButton#getCapSize capSize} and will be set
* to zero on the breadth axis. <P> So by default the label will be sized to match the center image of the
* StretchImgButton, but these settings allow the label to partially or wholly overlap the caps.
*
* @param labelVPad labelVPad Default value is null
*/
public void setLabelVPad(Integer labelVPad) {
setAttribute("labelVPad", labelVPad, true);
}
/**
* The padding for a StretchImgButton's label is determined as follows. <P> If <code>labelHPad</code> is set it will
* specify the horizontal padding applied to the label. Similarly if <code>labelVPad</code> is set it will specify the
* vertical padding for the label, regardless of the button's {@link
* com.smartgwt.client.widgets.StretchImgButton#getVertical vertical} setting. <P> Otherwise <code>labelLengthPad</code>
* can be set to specify the label padding along the length axis (ie: horizontal padding if {@link
* com.smartgwt.client.widgets.StretchImgButton#getVertical vertical} is false, otherwise vertical padding), and
* <code>labelBreadthPad</code> can be set to specify the label padding along the other axis. <P> Otherwise the padding on
* the length axis will match the {@link com.smartgwt.client.widgets.StretchImgButton#getCapSize capSize} and will be set
* to zero on the breadth axis. <P> So by default the label will be sized to match the center image of the
* StretchImgButton, but these settings allow the label to partially or wholly overlap the caps.
*
*
* @return Integer
*/
public Integer getLabelVPad() {
return getAttributeAsInt("labelVPad");
}
/**
* String identifier for this canvas's mutually exclusive selection group.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param radioGroup radioGroup Default value is null
* @see com.smartgwt.client.docs.State State overview and related methods
*/
public void setRadioGroup(String radioGroup) {
setAttribute("radioGroup", radioGroup, true);
}
/**
* String identifier for this canvas's mutually exclusive selection group.
*
*
* @return String
* @see com.smartgwt.client.docs.State State overview and related methods
*/
public String getRadioGroup() {
return getAttributeAsString("radioGroup");
}
/**
* Whether this component is selected. For some components, selection affects appearance.
*
* <br><br>If this method is called after the component has been drawn/initialized:
* Select this object.
*
* @param selected selected Default value is false
* @see com.smartgwt.client.docs.State State overview and related methods
*/
public void setSelected(Boolean selected) {
setAttribute("selected", selected, true);
}
/**
* Whether this component is selected. For some components, selection affects appearance.
*
*
* @return Boolean
* @see com.smartgwt.client.docs.State State overview and related methods
*/
public Boolean getSelected() {
return getAttributeAsBoolean("selected");
}
/**
* Should we visibly change state when disabled?
*
* @param showDisabled showDisabled Default value is true
* @see com.smartgwt.client.docs.State State overview and related methods
*/
public void setShowDisabled(Boolean showDisabled) {
setAttribute("showDisabled", showDisabled, true);
}
/**
* Should we visibly change state when disabled?
*
*
* @return Boolean
* @see com.smartgwt.client.docs.State State overview and related methods
*/
public Boolean getShowDisabled() {
return getAttributeAsBoolean("showDisabled");
}
/**
* If using an icon for this button, whether to switch the icon image if the button becomes disabled.
*
* @param showDisabledIcon showDisabledIcon Default value is true
* @throws IllegalStateException this property cannot be changed after the component has been created
* @see com.smartgwt.client.docs.ButtonIcon ButtonIcon overview and related methods
*/
public void setShowDisabledIcon(Boolean showDisabledIcon) throws IllegalStateException {
setAttribute("showDisabledIcon", showDisabledIcon, false);
}
/**
* If using an icon for this button, whether to switch the icon image if the button becomes disabled.
*
*
* @return Boolean
* @see com.smartgwt.client.docs.ButtonIcon ButtonIcon overview and related methods
*/
public Boolean getShowDisabledIcon() {
return getAttributeAsBoolean("showDisabledIcon");
}
/**
* Should we visibly change state when the mouse goes down in this object?
*
* @param showDown showDown Default value is false
* @see com.smartgwt.client.docs.State State overview and related methods
*/
public void setShowDown(Boolean showDown) {
setAttribute("showDown", showDown, true);
}
/**
* Should we visibly change state when the mouse goes down in this object?
*
*
* @return Boolean
* @see com.smartgwt.client.docs.State State overview and related methods
*/
public Boolean getShowDown() {
return getAttributeAsBoolean("showDown");
}
/**
* If using an icon for this button, whether to switch the icon image when the mouse goes down on the button.
*
* @param showDownIcon showDownIcon Default value is false
* @throws IllegalStateException this property cannot be changed after the component has been created
* @see com.smartgwt.client.docs.ButtonIcon ButtonIcon overview and related methods
*/
public void setShowDownIcon(Boolean showDownIcon) throws IllegalStateException {
setAttribute("showDownIcon", showDownIcon, false);
}
/**
* If using an icon for this button, whether to switch the icon image when the mouse goes down on the button.
*
*
* @return Boolean
* @see com.smartgwt.client.docs.ButtonIcon ButtonIcon overview and related methods
*/
public Boolean getShowDownIcon() {
return getAttributeAsBoolean("showDownIcon");
}
/**
* Should we visibly change state when the canvas receives focus? If {@link
* com.smartgwt.client.widgets.StatefulCanvas#getShowFocusedAsOver showFocusedAsOver} is <code>true</code>, the
* <b><code>"over"</code></b> will be used to indicate focus. Otherwise a separate <b><code>"focused"</code></b> state will
* be used.
*
* @param showFocused showFocused Default value is false
* @see com.smartgwt.client.docs.State State overview and related methods
*/
public void setShowFocused(Boolean showFocused) {
setAttribute("showFocused", showFocused, true);
}
/**
* Should we visibly change state when the canvas receives focus? If {@link
* com.smartgwt.client.widgets.StatefulCanvas#getShowFocusedAsOver showFocusedAsOver} is <code>true</code>, the
* <b><code>"over"</code></b> will be used to indicate focus. Otherwise a separate <b><code>"focused"</code></b> state will
* be used.
*
*
* @return Boolean
* @see com.smartgwt.client.docs.State State overview and related methods
*/
public Boolean getShowFocused() {
return getAttributeAsBoolean("showFocused");
}
/**
* If using an icon for this button, whether to switch the icon image when the button receives focus. <P> If {@link
* com.smartgwt.client.widgets.StatefulCanvas#getShowFocusedAsOver showFocusedAsOver} is true, the <code>"Over"</code> icon
* will be displayed when the canvas has focus, otherwise a separate <code>"Focused"</code> icon will be displayed
*
* @param showFocusedIcon showFocusedIcon Default value is false
* @throws IllegalStateException this property cannot be changed after the component has been created
* @see com.smartgwt.client.docs.ButtonIcon ButtonIcon overview and related methods
*/
public void setShowFocusedIcon(Boolean showFocusedIcon) throws IllegalStateException {
setAttribute("showFocusedIcon", showFocusedIcon, false);
}
/**
* If using an icon for this button, whether to switch the icon image when the button receives focus. <P> If {@link
* com.smartgwt.client.widgets.StatefulCanvas#getShowFocusedAsOver showFocusedAsOver} is true, the <code>"Over"</code> icon
* will be displayed when the canvas has focus, otherwise a separate <code>"Focused"</code> icon will be displayed
*
*
* @return Boolean
* @see com.smartgwt.client.docs.ButtonIcon ButtonIcon overview and related methods
*/
public Boolean getShowFocusedIcon() {
return getAttributeAsBoolean("showFocusedIcon");
}
/**
* Should we visibly change state when the mouse goes over this object?
*
* @param showRollOver showRollOver Default value is false
* @see com.smartgwt.client.docs.State State overview and related methods
*/
public void setShowRollOver(Boolean showRollOver) {
setAttribute("showRollOver", showRollOver, true);
}
/**
* Should we visibly change state when the mouse goes over this object?
*
*
* @return Boolean
* @see com.smartgwt.client.docs.State State overview and related methods
*/
public Boolean getShowRollOver() {
return getAttributeAsBoolean("showRollOver");
}
/**
* If using an icon for this button, whether to switch the icon image on mouse rollover.
*
* @param showRollOverIcon showRollOverIcon Default value is false
* @throws IllegalStateException this property cannot be changed after the component has been created
* @see com.smartgwt.client.docs.ButtonIcon ButtonIcon overview and related methods
*/
public void setShowRollOverIcon(Boolean showRollOverIcon) throws IllegalStateException {
setAttribute("showRollOverIcon", showRollOverIcon, false);
}
/**
* If using an icon for this button, whether to switch the icon image on mouse rollover.
*
*
* @return Boolean
* @see com.smartgwt.client.docs.ButtonIcon ButtonIcon overview and related methods
*/
public Boolean getShowRollOverIcon() {
return getAttributeAsBoolean("showRollOverIcon");
}
/**
* If using an icon for this button, whether to switch the icon image when the button becomes selected.
*
* @param showSelectedIcon showSelectedIcon Default value is false
* @throws IllegalStateException this property cannot be changed after the component has been created
* @see com.smartgwt.client.docs.ButtonIcon ButtonIcon overview and related methods
*/
public void setShowSelectedIcon(Boolean showSelectedIcon) throws IllegalStateException {
setAttribute("showSelectedIcon", showSelectedIcon, false);
}
/**
* If using an icon for this button, whether to switch the icon image when the button becomes selected.
*
*
* @return Boolean
* @see com.smartgwt.client.docs.ButtonIcon ButtonIcon overview and related methods
*/
public Boolean getShowSelectedIcon() {
return getAttributeAsBoolean("showSelectedIcon");
}
/**
* Determines whether any specified {@link com.smartgwt.client.widgets.StatefulCanvas#getTitle title} will be displayed
* for this component.<br> Applies to Image-based components only, where the title will be rendered out in a label floating
* over the component
*
* @param showTitle showTitle Default value is true
*/
public void setShowTitle(Boolean showTitle) {
setAttribute("showTitle", showTitle, true);
}
/**
* Determines whether any specified {@link com.smartgwt.client.widgets.StatefulCanvas#getTitle title} will be displayed
* for this component.<br> Applies to Image-based components only, where the title will be rendered out in a label floating
* over the component
*
*
* @return Boolean
*/
public Boolean getShowTitle() {
return getAttributeAsBoolean("showTitle");
}
/**
* Base URL for the image. By default, StretchImgButtons consist of three image parts: A start image (displayed at the top
* or left), a scalable central image and an end image displayed at the bottom or right. <P> The images displayed in the
* stretchImgButton are derived from this property in the following way: <P> <ul> <li> When the button is in its standard
* state the suffixes "_start", "_end" and "_stretch" are applied to the src (before the file extension), so by
* default the images displayed will be "button_start.gif" (sized to be <code>this.capSize</code> by the
* specified width of the stretchImgButton), "button_stretch.gif" (stretched to the necessary width) and
* "button_end.gif" (sized the same as the start image). <li> As the button's state changes, the images will have
* suffixes appended <b>before</b> the "_start" / "_end" / "_stretch" to represent the button state. Possible states
* are "Down", "Over", "Selected" "Focused" and "Disabled". Note that "Selected" and "Focused" are compound states
* which may be applied in addition to "Down" etc. </ul> For example the center piece of a selected stretchImgButton with
* the mouse hovering over it might have the URL: <code>"button_Selected_Down_stretch.gif"</code>. <P> Media should be
* present for each possible state of the _start, _end and _stretch images.
*
* @param src src Default value is "button.gif"
*/
public void setSrc(String src) {
setAttribute("src", src, true);
}
/**
* Base URL for the image. By default, StretchImgButtons consist of three image parts: A start image (displayed at the top
* or left), a scalable central image and an end image displayed at the bottom or right. <P> The images displayed in the
* stretchImgButton are derived from this property in the following way: <P> <ul> <li> When the button is in its standard
* state the suffixes "_start", "_end" and "_stretch" are applied to the src (before the file extension), so by
* default the images displayed will be "button_start.gif" (sized to be <code>this.capSize</code> by the
* specified width of the stretchImgButton), "button_stretch.gif" (stretched to the necessary width) and
* "button_end.gif" (sized the same as the start image). <li> As the button's state changes, the images will have
* suffixes appended <b>before</b> the "_start" / "_end" / "_stretch" to represent the button state. Possible states
* are "Down", "Over", "Selected" "Focused" and "Disabled". Note that "Selected" and "Focused" are compound states
* which may be applied in addition to "Down" etc. </ul> For example the center piece of a selected stretchImgButton with
* the mouse hovering over it might have the URL: <code>"button_Selected_Down_stretch.gif"</code>. <P> Media should be
* present for each possible state of the _start, _end and _stretch images.
*
*
* @return String
*/
public String getSrc() {
return getAttributeAsString("src");
}
/**
* Current "state" of this widget. StatefulCanvases will have a different appearance based on their current state. By
* default this is handled by changing the css className applied to the StatefulCanvas - see {@link
* com.smartgwt.client.widgets.StatefulCanvas#getBaseStyle baseStyle} for a description of how this is done.<P> For {@link
* com.smartgwt.client.widgets.Img} or {@link com.smartgwt.client.widgets.StretchImg} based subclasses of StatefulCanvas,
* the appearance may also be updated by changing the src of the rendered image. See {@link
* com.smartgwt.client.widgets.Img#getSrc src} and {@link com.smartgwt.client.widgets.StretchImgButton#getSrc src} for a
* description of how the URL is modified to reflect the state of the widget in this case.
*
* <br><br>If this method is called after the component has been drawn/initialized:
* Set the 'state' of this object, this changes it's appearance.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param state new state. Default value is ""
* @see com.smartgwt.client.types.State
* @see com.smartgwt.client.docs.State State overview and related methods
*/
public void setState(State state) {
setAttribute("state", state.getValue(), true);
}
/**
* Current "state" of this widget. StatefulCanvases will have a different appearance based on their current state. By
* default this is handled by changing the css className applied to the StatefulCanvas - see {@link
* com.smartgwt.client.widgets.StatefulCanvas#getBaseStyle baseStyle} for a description of how this is done.<P> For {@link
* com.smartgwt.client.widgets.Img} or {@link com.smartgwt.client.widgets.StretchImg} based subclasses of StatefulCanvas,
* the appearance may also be updated by changing the src of the rendered image. See {@link
* com.smartgwt.client.widgets.Img#getSrc src} and {@link com.smartgwt.client.widgets.StretchImgButton#getSrc src} for a
* description of how the URL is modified to reflect the state of the widget in this case.
*
*
* @return Return the state of this StatefulCanvas
* @see com.smartgwt.client.types.State
* @see com.smartgwt.client.docs.State State overview and related methods
*/
public State getState() {
return EnumUtil.getEnum(State.values(), getAttribute("state"));
}
/**
* The text title to display in this button.
*
* <br><br>If this method is called after the component has been drawn/initialized:
* Set the title.
*
* @param title new title. Default value is varies
* @see com.smartgwt.client.docs.Basics Basics overview and related methods
*/
public void setTitle(String title) {
setAttribute("title", title, true);
}
/**
* The text title to display in this button.
*
*
* @return Return the title - text/HTML drawn inside the component. <p> Default is to simply return this.title.
* @see com.smartgwt.client.docs.Basics Basics overview and related methods
*/
public String getTitle() {
return getAttributeAsString("title");
}
/**
* CSS style applied to the title text only. Defaults to {@link com.smartgwt.client.widgets.StretchImgButton#getBaseStyle
* baseStyle} when unset. <P> With a separate <code>titleStyle</code> and {@link
* com.smartgwt.client.widgets.StretchImgButton#getBaseStyle baseStyle} set, you can provide a backgroundColor via
* <code>baseStyle</code> that will allow translucent .png media to be "tinted" by the underlying background color, so that
* a single set of media can provide range of color options. In this usage, the <code>titleStyle</code> should generally
* not specify a background color as this would block out the media that appears behind the title.
*
* <br><br>If this method is called after the component has been drawn/initialized:
* Sets the {@link com.smartgwt.client.widgets.StretchImgButton#getTitleStyle titleStyle}, which is applied to the title text.
*
* @param titleStyle new title style. Default value is null
*/
public void setTitleStyle(String titleStyle) {
setAttribute("titleStyle", titleStyle, true);
}
/**
* CSS style applied to the title text only. Defaults to {@link com.smartgwt.client.widgets.StretchImgButton#getBaseStyle
* baseStyle} when unset. <P> With a separate <code>titleStyle</code> and {@link
* com.smartgwt.client.widgets.StretchImgButton#getBaseStyle baseStyle} set, you can provide a backgroundColor via
* <code>baseStyle</code> that will allow translucent .png media to be "tinted" by the underlying background color, so that
* a single set of media can provide range of color options. In this usage, the <code>titleStyle</code> should generally
* not specify a background color as this would block out the media that appears behind the title.
*
*
* @return String
*/
public String getTitleStyle() {
return getAttributeAsString("titleStyle");
}
/**
* Vertical alignment of this component's title.
*
* @param valign valign Default value is Canvas.CENTER
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
*/
public void setValign(VerticalAlignment valign) {
setAttribute("valign", valign.getValue(), true);
}
/**
* Vertical alignment of this component's title.
*
*
* @return VerticalAlignment
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
*/
public VerticalAlignment getValign() {
return EnumUtil.getEnum(VerticalAlignment.values(), getAttribute("valign"));
}
/**
* Default is a horizontal button. Vertical StretchImgButtons are allowed, but title text, if any, will not be
* automatically rotated.
*
* @param vertical vertical Default value is false
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
*/
public void setVertical(Boolean vertical) {
setAttribute("vertical", vertical, true);
}
/**
* Default is a horizontal button. Vertical StretchImgButtons are allowed, but title text, if any, will not be
* automatically rotated.
*
*
* @return Boolean
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
*/
public Boolean getVertical() {
return getAttributeAsBoolean("vertical");
}
/**
* Should the title for this button wrap? If unset, default behavior is to allow wrapping if this.vertical is true,
* otherwise disallow wrapping
*
* @param wrap wrap Default value is null
*/
public void setWrap(Boolean wrap) {
setAttribute("wrap", wrap, true);
}
/**
* Should the title for this button wrap? If unset, default behavior is to allow wrapping if this.vertical is true,
* otherwise disallow wrapping
*
*
* @return Boolean
*/
public Boolean getWrap() {
return getAttributeAsBoolean("wrap");
}
// ********************* Methods ***********************
// /**
// * This property contains the default 'action' for the Button to fire when activated.
// */
// public native void action() /*-{
// var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
// self.action();
// }-*/;
//
// /**
// * Add this widget to the specified mutually exclusive selection group with the ID passed in. Selecting this widget will
// * then deselect any other StatefulCanvases with the same radioGroup ID. StatefulCanvases can belong to only one
// * radioGroup, so this method will remove from any other radiogroup of which this button is already a member.
// * @param groupID - ID of the radiogroup to which this widget should be added
// */
// public native void addToRadioGroup(String groupID) /*-{
// var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
// self.addToRadioGroup(groupID);
// }-*/;
//
// /**
// * Select this object.
// */
// public native void deselect() /*-{
// var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
// self.deselect();
// }-*/;
// /**
// * Add a iconClick handler.
// * <p>
// * If this button is showing an {@link com.smartgwt.client.widgets.StretchImgButton#getIcon icon}, a separate click handler
// * for the icon may be defined as <code>this.iconClick</code>. Returning false will suppress the standard button click
// * handling code.
// *
// * @param handler the iconClick handler
// * @return {@link HandlerRegistration} used to remove this handler
// */
// public HandlerRegistration addIconClickHandler(com.smartgwt.client.widgets.events.IconClickHandler handler) {
// if(getHandlerCount(com.smartgwt.client.widgets.events.IconClickEvent.getType()) == 0) setupIconClickEvent();
// return doAddHandler(handler, com.smartgwt.client.widgets.events.IconClickEvent.getType());
// }
//
// private native void setupIconClickEvent() /*-{
// var obj = null;
// var selfJ = this;
// if(this.@com.smartgwt.client.widgets.BaseWidget::isCreated()()) {
// obj = this.@com.smartgwt.client.widgets.BaseWidget::getJsObj()();
// obj.addProperties({iconClick:$debox($entry(function(){
// var param = {};
// var event = @com.smartgwt.client.widgets.events.IconClickEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
// selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
// var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
// return !ret;
// }))
// });
// } else {
// obj = this.@com.smartgwt.client.widgets.BaseWidget::getConfig()();
// obj.iconClick = $debox($entry(function(){
// var param = {};
// var event = @com.smartgwt.client.widgets.events.IconClickEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
// selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
// var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
// return !ret;
// }));
// }
// }-*/;
//
// /**
// * Find out if this object is selected
// *
// * @return
// * @see com.smartgwt.client.docs.State State overview and related methods
// */
// public native Boolean isSelected() /*-{
// var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
// var retVal =self.isSelected();
// if(retVal == null || retVal === undefined) {
// return null;
// } else {
// return @com.smartgwt.client.util.JSOHelper::toBoolean(Z)(retVal);
// }
// }-*/;
//
// /**
// * Remove this widget from the specified mutually exclusive selection group with the ID passed in. No-op's if this widget
// * is not a member of the groupID passed in. If no groupID is passed in, defaults to removing from whatever radioGroup this
// * widget is a member of.
// */
// public native void removeFromRadioGroup() /*-{
// var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
// self.removeFromRadioGroup();
// }-*/;
//
// /**
// * Remove this widget from the specified mutually exclusive selection group with the ID passed in. No-op's if this widget
// * is not a member of the groupID passed in. If no groupID is passed in, defaults to removing from whatever radioGroup this
// * widget is a member of.
// * @param groupID - optional radio group ID (to ensure the widget is removed from the appropriate
// * group.
// * @see com.smartgwt.client.docs.State State overview and related methods
// */
// public native void removeFromRadioGroup(String groupID) /*-{
// var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
// self.removeFromRadioGroup(groupID);
// }-*/;
//
// /**
// * Select this object.
// */
// public native void select() /*-{
// var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
// self.select();
// }-*/;
//
// // ********************* Static Methods ***********************
// /**
// * Class level method to set the default properties of this class. If set, then all subsequent instances of this
// * class will automatically have the default properties that were set when this method was called. This is a powerful
// * feature that eliminates the need for users to create a separate hierarchy of subclasses that only alter the default
// * properties of this class. Can also be used for skinning / styling purposes.
// * <P>
// * <b>Note:</b> This method is intended for setting default attributes only and will effect all instances of the
// * underlying class (including those automatically generated in JavaScript).
// * This method should not be used to apply standard EventHandlers or override methods for
// * a class - use a custom subclass instead.
// *
// * @param stretchImgButtonProperties properties that should be used as new defaults when instances of this class are created
// */
// public static native void setDefaultProperties(StretchImgButton stretchImgButtonProperties) /*-{
// var properties = $wnd.isc.addProperties({},stretchImgButtonProperties.@com.smartgwt.client.widgets.BaseWidget::getConfig()());
// delete properties.ID;
// $wnd.isc.StretchImgButton.addProperties(properties);
// }-*/;
//
// // ***********************************************************
}