Package snap.view

Class ToggleButton

java.lang.Object

snap.props.PropObject

snap.view.View

snap.view.ParentView

snap.view.ButtonBase

snap.view.ToggleButton

All Implemented Interfaces:

PropChange.DoChange, XMLArchiver.Archivable

Direct Known Subclasses:

CheckBox, RadioButton

public class ToggleButton
extends ButtonBase

A ButtonBase subclass for ToggleButton.

Nested Class Summary

Nested classes/interfaces inherited from class snap.view.View

View.Overflow

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GroupName_Prop
static final String	Selected_Prop

Fields inherited from class snap.view.ButtonBase

_showArea, _targeted, BUTTON_NORMAL, BUTTON_OVER, BUTTON_PRESSED, ImageName_Prop, Position_Prop, Pressed_Prop, ShowArea_Prop, Targeted_Prop

Fields inherited from class snap.view.ParentView

_children, Children_Prop, NeedsLayout_Prop

Fields inherited from class snap.view.View

_align, _border, _borderRadius, _effect, _fill, _font, _margin, _padding, _repaintRect, _showing, _spacing, _vertical, Action, Align_Prop, Border_Prop, BorderRadius_Prop, Cursor_Prop, Disabled_Prop, DragEvents, Effect_Prop, Fill_Prop, Focusable_Prop, Focused_Prop, FocusWhenPressed_Prop, Font_Prop, GrowHeight_Prop, GrowWidth_Prop, Height_Prop, KeyEvents, KeyPress, KeyRelease, KeyType, LeanX_Prop, LeanY_Prop, Managed_Prop, Margin_Prop, MaxHeight_Prop, MaxWidth_Prop, MinHeight_Prop, MinWidth_Prop, MouseDrag, MouseEnter, MouseEvents, MouseExit, MouseMove, MousePress, MouseRelease, Name_Prop, Opacity_Prop, Overflow_Prop, Padding_Prop, Paintable_Prop, Parent_Prop, Pickable_Prop, PrefHeight_Prop, PrefWidth_Prop, Rotate_Prop, RuntimeClassName_Prop, ScaleX_Prop, ScaleY_Prop, Scroll, Showing_Prop, Spacing_Prop, Text_Prop, TextColor_Prop, ToolTip_Prop, TransX_Prop, TransY_Prop, Vertical_Prop, Visible_Prop, Width_Prop, X_Prop, Y_Prop

Fields inherited from class snap.props.PropObject

_pcs, EMPTY_OBJECT

Constructor Summary

Constructors

Constructor	Description
ToggleButton()	Constructor.
ToggleButton(String aStr)	Constructor for given label text.

Method Summary

Modifier and Type	Method	Description
protected void	fireActionEvent(ViewEvent anEvent)	Override to toggle Selected state (if no ToggleGroup or not selected).
protected void	fromXMLView(XMLArchiver anArchiver, XMLElement anElement)	XML unarchival.
String	getGroupName()	Returns the button group name.
Object	getPropValue(String aPropName)	Returns the value for given prop name.
ToggleGroup	getToggleGroup()	Returns the button group name.
protected String	getValuePropName()	Returns a mapped property name.
protected void	initProps(PropSet aPropSet)	Initialize Props.
boolean	isSelected()	Returns whether button is selected.
void	setGroupName(String aName)	Sets the button group name.
void	setOwner(ViewOwner anOwner)	Override to add to ToggleGroup if name is set.
void	setPropValue(String aPropName, Object aValue)	Sets the value for given prop name.
void	setSelected(boolean aValue)	Sets whether button is selected.
protected XMLElement	toXMLView(XMLArchiver anArchiver)	XML archival.

Methods inherited from class snap.view.ButtonBase

createActionEvent, fire, getGraphic, getGraphicAfter, getImage, getImageAfter, getImageName, getLabel, getPosition, getPrefHeightImpl, getPrefWidthImpl, getSharedAction, getText, getTextColor, getViewProxy, isPressed, isShowArea, isTargeted, layoutImpl, paintAll, paintButton, paintFront, processEvent, setDisabled, setGraphic, setGraphicAfter, setImage, setImageAfter, setImageName, setPosition, setPressed, setSharedAction, setShowArea, setTargeted, setText, setTextColor

Methods inherited from class snap.view.ParentView

addChild, addChild, addDeepChangeListener, childDidDeepChange, childDidPropChange, fromXML, fromXMLChildren, getChild, getChildAtXY, getChildCount, getChildCountManaged, getChildForClass, getChildForName, getChildLast, getChildren, getChildrenArray, getChildrenForClass, getChildrenInPaintOrder, getChildrenManaged, getFocusNext, getFocusPrev, indexOfChild, intersectsShape, isInLayout, isNeedsLayout, isNeedsLayoutDeep, isNeedsRepaintDeep, layout, layoutDeep, layoutDeepImpl, layoutFloatingViews, paintChildren, parentFontChanged, processPropChange, relayout, removeChild, removeChild, removeChildren, removeDeepChangeListener, setChildren, setFont, setNeedsLayout, setNeedsLayoutDeep, setNeedsRepaintDeep, setOwnerChildren, setShowing, themeChanged, toXML, toXMLChildren

Methods inherited from class snap.view.View

addEventFilter, addEventHandler, clone, contains, contains, containsShape, disableEvents, enableEvents, getAlign, getAlignX, getAlignY, getAnim, getAnimCleared, getAnimTimeDeep, getBestHeight, getBestSize, getBestWidth, getBorder, getBorderRadius, getBounds, getBoundsLocal, getBoundsParent, getBoundsShape, getBoundsShapeParent, getClip, getClipAll, getClipBounds, getClipBoundsAll, getCursor, getDefaultFont, getEffect, getEnv, getEventAdapter, getFill, getFillColor, getFocusNext, getFocusPrev, getFont, getHeight, getHost, getInsetsAll, getLean, getLeanX, getLeanY, getLocalToParent, getLocalToParent, getMargin, getMaxHeight, getMaxSize, getMaxWidth, getMaxX, getMaxY, getMidX, getMidY, getMinHeight, getMinHeightImpl, getMinSize, getMinWidth, getMinWidthImpl, getName, getOpacity, getOpacityAll, getOverflow, getOwner, getOwner, getPadding, getParent, getParent, getParentCount, getParentToLocal, getParentToLocal, getPhysics, getPhysics, getPrefHeight, getPrefHeight, getPrefSize, getPrefWidth, getPrefWidth, getProp, getPropDefault, getProps, getRepaintRect, getRepaintRectExpanded, getRootView, getRotate, getRuntimeClassName, getScale, getScaleX, getScaleY, getSize, getSpacing, getToolTip, getToolTip, getTransX, getTransY, getUpdater, getVisibleBounds, getWidth, getWindow, getX, getXY, getY, indexInHost, indexInParent, initStyleProps, isActionable, isAncestor, isAnimActive, isClipToBounds, isDisabled, isEnabled, isFocusable, isFocused, isFocusKeysEnabled, isFocusPainted, isFocusWhenPressed, isFontSet, isGrowHeight, isGrowWidth, isGuest, isHorizontal, isLocalToParentSimple, isManaged, isManagedVisible, isMaxHeightSet, isMaxWidthSet, isMinHeightSet, isMinWidthSet, isMouseDown, isMouseOver, isNeedsRepaint, isPaintable, isPickable, isPickableVisible, isPrefHeightSet, isPrefWidthSet, isPropDefault, isShowing, isToolTipEnabled, isVertical, isVisible, localToParent, localToParent, localToParent, localToParent, localToScreen, paintAbove, paintBack, parentToLocal, parentToLocal, parentToLocal, parentToLocal, playAnimDeep, processEventAll, processEventFilters, processEventHandlers, relayoutParent, removeEventFilter, removeEventHandler, repaint, repaint, repaint, repaintInParent, requestFocus, runDelayed, runIntervals, runLater, scrollToVisible, setActionable, setAlign, setAlignX, setAlignY, setAnimString, setAnimTimeDeep, setBorder, setBorder, setBorderRadius, setBounds, setBounds, setBoundsLocal, setClipToBounds, setCursor, setEffect, setEnabled, setFill, setFocusable, setFocused, setFocusKeysEnabled, setFocusPainted, setFocusWhenPressed, setGrowHeight, setGrowWidth, setHeight, setLean, setLeanX, setLeanY, setManaged, setMargin, setMargin, setMaxHeight, setMaxSize, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinSize, setMinWidth, setName, setOpacity, setOverflow, setPadding, setPadding, setPaintable, setParent, setPickable, setPrefHeight, setPrefSize, setPrefSize, setPrefWidth, setProp, setRotate, setRuntimeClassName, setScale, setScaleX, setScaleY, setSize, setSize, setSizeLocal, setSizeToBestSize, setSizeToPrefSize, setSpacing, setToolTip, setToolTipEnabled, setTransX, setTransY, setVertical, setVisible, setWidth, setX, setXY, setXYLocal, setY, stopAnimDeep, stopIntervals, toStringProps

Methods inherited from class snap.props.PropObject

addPropChangeListener, addPropChangeListener, firePropChange, firePropChange, firePropChange, getPropForName, getPropParent, getPropSet, getPropsForArchival, getPropsForArchivalExtra, getPropsString, processArchivedNode, processUnarchivedNode, removePropChangeListener, removePropChangeListener, setPropsString, setPropValues, toString

Methods inherited from class java.lang.Object

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

Field Details

Selected_Prop

public static final String Selected_Prop

See Also:

• Constant Field Values

GroupName_Prop

public static final String GroupName_Prop

See Also:

• Constant Field Values

Constructor Details

ToggleButton

public ToggleButton()

Constructor.

ToggleButton

public ToggleButton(String aStr)

Constructor for given label text.

Method Details

isSelected

public boolean isSelected()

Returns whether button is selected.

Overrides:

isSelected in class ButtonBase

setSelected

public void setSelected(boolean aValue)

Sets whether button is selected.

getToggleGroup

public ToggleGroup getToggleGroup()

Returns the button group name.

getGroupName

public String getGroupName()

Returns the button group name.

setGroupName

public void setGroupName(String aName)

Sets the button group name.

fireActionEvent

protected void fireActionEvent(ViewEvent anEvent)

Override to toggle Selected state (if no ToggleGroup or not selected).

Overrides:

fireActionEvent in class ButtonBase

getValuePropName

protected String getValuePropName()

Returns a mapped property name.

Overrides:

getValuePropName in class View

setOwner

public void setOwner(ViewOwner anOwner)

Override to add to ToggleGroup if name is set.

Overrides:

setOwner in class ParentView

initProps

protected void initProps(PropSet aPropSet)

Initialize Props. Override to provide custom defaults.

Overrides:

initProps in class ButtonBase

getPropValue

public Object getPropValue(String aPropName)

Returns the value for given prop name.

Overrides:

getPropValue in class ButtonBase

setPropValue

public void setPropValue(String aPropName,
 Object aValue)

Sets the value for given prop name.

Overrides:

setPropValue in class ButtonBase

toXMLView

protected XMLElement toXMLView(XMLArchiver anArchiver)

XML archival.

Overrides:

toXMLView in class ButtonBase

fromXMLView

protected void fromXMLView(XMLArchiver anArchiver,
 XMLElement anElement)

XML unarchival.

Overrides:

fromXMLView in class ButtonBase