com.smartgwt.mobile.client.widgets.layout

Class SegmentedControl

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.Panel

com.google.gwt.user.client.ui.ComplexPanel

com.smartgwt.mobile.client.widgets.Canvas

com.smartgwt.mobile.client.widgets.layout.Layout

com.smartgwt.mobile.client.widgets.layout.HLayout

com.smartgwt.mobile.client.widgets.layout.SegmentedControl

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IndexedPanel, com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, com.smartgwt.mobile.client.internal.test.AutoTestLocatable, HasClickHandlers, HasDragMoveHandlers, HasShowContextMenuHandlers, PanelContainer, java.lang.Iterable<com.google.gwt.user.client.ui.Widget>

public class SegmentedControl
extends HLayout
implements PanelContainer

A SegmentedControl is a horizontal control consisting of multiple Segment's.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

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

com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget

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

com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	tintColor The tint color.

Fields inherited from class com.smartgwt.mobile.client.widgets.layout.Layout

alignment, enforcePolicy, hPolicy, members, membersMargin, minMemberSize, momentumScroll, overflow, paddingAsLayoutMargin, reverseOrder, valign, vertical

Fields inherited from class com.smartgwt.mobile.client.widgets.Canvas

_CONTENT_CHANGED_EVENT_TYPE, _CSS, _HISTORY_ENABLED, _REQUEST_SCROLL_TO_EVENT_TYPE, id, touched

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
SegmentedControl()

Method Summary

Modifier and Type	Method and Description
ContainerFeatures	getContainerFeatures()
Segment[]	getSegments() Return the segments in the controller.
int	getSelectedIndex() Return the index of the selected segment.
Segment	getSelectedSegment()
java.lang.String	getTintColor() Return the tint color of the control.
boolean	isInheritTint() Whether the control should inherit the tint from the toolbar.
boolean	isMomentary() Return true if segments show selected state.
boolean	isStretch() Should the button stretch in width?
boolean	selectSegment(int index) Select the specified segment.
boolean	selectSegment(Segment otherSegment)
void	setInheritTint(boolean inheritTint) Whether the control should inherit the tint from the toolbar.
void	setMomentary(boolean momentary) Set true if the segmented control should not display the selected state of a segment.
void	setSegments(Segment... segments) Sets the segments of this segment controller.
boolean	setSelectedIndex(int selectedIndex) Sets the selected segment.
void	setStretch(boolean stretch) Should the button stretch in width?
void	setTintColor(java.lang.String tintColor) Set the button tintColor.

Methods inherited from class com.smartgwt.mobile.client.widgets.layout.HLayout

addMember, addMember

Methods inherited from class com.smartgwt.mobile.client.widgets.layout.Layout

addDragMoveHandler, addMember, addMember, addMembers, addMembers, addMembers, clear, getEnforcePolicy, getHPolicy, getLayoutBottomMargin, getLayoutLeftMargin, getLayoutMargin, getLayoutRightMargin, getLayoutTopMargin, getManagePercentBreadth, getMember, getMember, getMemberNumber, getMemberNumber, getMembers, getMembersMargin, getMinMemberSize, getMomentumScroll, getOverflow, getPaddingAsLayoutMargin, getReverseOrder, getVertical, getVPolicy, hasMember, hideMember, hideMember, reflow, removeMember, removeMember, removeMembers, removeMembers, reorderMember, reorderMembers, setAlign, setAlign, setDefaultLayoutAlign, setDefaultLayoutAlign, setEnforcePolicy, setHPolicy, setLayoutBottomMargin, setLayoutLeftMargin, setLayoutMargin, setLayoutRightMargin, setLayoutTopMargin, setManagePercentBreadth, setMembers, setMembersMargin, setMinMemberSize, setMomentumScroll, setOverflow, setPaddingAsLayoutMargin, setReverseOrder, setVertical, setVisibleMember, setVPolicy, showMember, showMember

Methods inherited from class com.smartgwt.mobile.client.widgets.Canvas

_add, _booleanValue, _fireContentChangedEvent, _fireContentChangedEvent, _fireRequestScrollToEvent, _getAndroidWindowSoftInputMode, _getAttributeFromSplitLocator, _getChildFromLocatorSubstring, _getFixNavigationBarPositionDuringKeyboardFocus, _getHideTabBarDuringKeyboardFocus, _getInnerAttributeFromSplitLocator, _getInnerElement, _hideAddressBar, _hideAddressBarNow, _insert, _isDifferent, _isHDPIDisplay, _isIOS4OrOlder, _isIOS5, _isIOSMin6_0, _isStandaloneMode, _nativeParseFloat, _removeClassName, _setClassName, _setHandleDisabled, _sinkAnimationEndEvent, _sinkContentChangedEvent, _sinkFocusInEvent, _sinkFocusOutEvent, _sinkInputEvent, _sinkRequestScrollToEvent, _sinkTransitionEndEvent, _triggerDebugger, addChild, addChild, addChild, addClickHandler, addShowContextMenuHandler, destroy, disable, enable, getContextMenu, getID, getInnerHTML, getMargin, hasChild, hasChild, isAndroid, isDisabled, isEnabled, isIPad, isIPhone, isSafari, isStandAlone, isUIWebView, onBrowserEvent, parseDimension, removeChild, removeChild, setContents, setContextMenu, setDisabled, setElement, setID, setMargin, setStyleName, split, useIOSNativeScrolling

Methods inherited from class com.google.gwt.user.client.ui.ComplexPanel

add, add, adjustIndex, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, getChildren, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, insert, iterator, remove, remove

Methods inherited from class com.google.gwt.user.client.ui.Panel

add, add, adopt, doAttachChildren, doDetachChildren, orphan, remove

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

tintColor

protected java.lang.String tintColor

The tint color. Only applicable if the control is added to a ToolStrip.

Constructor Detail

SegmentedControl

public SegmentedControl()

Method Detail

getSegments

public final Segment[] getSegments()

Return the segments in the controller.

Returns:

the segments, or null if none set

setSegments

public void setSegments(Segment... segments)

Sets the segments of this segment controller.

Parameters:

segments - the segments

isMomentary

public final boolean isMomentary()

Return true if segments show selected state.

Returns:

momentary value. Defaults to false.

setMomentary

public void setMomentary(boolean momentary)

Set true if the segmented control should not display the selected state of a segment. Defaults to false.

Parameters:

momentary - the momentary value

getTintColor

public java.lang.String getTintColor()

Return the tint color of the control.

Returns:

the tintColor

setTintColor

public void setTintColor(java.lang.String tintColor)

Set the button tintColor. Can pass in the color name, the hext value, or the rgb / rgba value as a String.

Note: Passing a rgba string with a value for opacity allows buttons to have an opacity / translucency.

Parameters:

tintColor - the tint color

isInheritTint

public boolean isInheritTint()

Whether the control should inherit the tint from the toolbar. Applies only to segmented controls added to a toolbar.

Returns:

true if inherits tint. Defaults to false

setInheritTint

public void setInheritTint(boolean inheritTint)

Whether the control should inherit the tint from the toolbar. Applies only to segmented controls added to a toolbar.

Parameters:

inheritTint - true if inherits tint. Defaults to false

isStretch

public boolean isStretch()

Should the button stretch in width?

Returns:

true for stretch, false for auto-width based on contents

setStretch

public void setStretch(boolean stretch)

Should the button stretch in width?

Parameters:

stretch - true for stretch, false for auto-width based on contents

selectSegment

public boolean selectSegment(Segment otherSegment)

getSelectedIndex

public final int getSelectedIndex()

Return the index of the selected segment. Returns -1 if momentary is true or if no segments are selected.

Returns:

the selected segment index

getSelectedSegment

public final Segment getSelectedSegment()

setSelectedIndex

public boolean setSelectedIndex(int selectedIndex)

Sets the selected segment.

Parameters:

selectedIndex - the index of the segment to select

selectSegment

public boolean selectSegment(int index)

Select the specified segment.

Parameters:

index - the index of the segment to select

Returns:

true is selection was successful

getContainerFeatures

public ContainerFeatures getContainerFeatures()

Specified by:

getContainerFeatures in interface PanelContainer