SimpleButton class Null safety

The SimpleButton class lets you control all instances of button symbols.

Inheritance

Constructors

SimpleButton([DisplayObject? upState, DisplayObject? overState, DisplayObject? downState, DisplayObject? hitTestState])
Creates a new SimpleButton instance.

Properties

alpha num
The alpha transparency value of the object specified.
read / writeinherited
blendMode BlendMode?
A value from the BlendMode class that specifies which blend mode to use.
read / writeinherited
bounds Rectangle<num>
Returns a rectangle that defines the area of this display object in this display object's local coordinates.
read-onlyoverride
boundsTransformed Rectangle<num>
Returns a rectangle that defines the area of this display object in this display object's parent coordinates.
read-onlyinherited
cache RenderTextureQuad?
This getter gives you access to the underlying RenderTextureQuad if a cache is applied to this display object. If no cache is applied this value is ´null´.
read-onlyinherited
displayObjectID int
finalinherited
doubleClickEnabled bool
Specifies whether the object receives doubleClick events.
read / writeinherited
downState DisplayObject?
Specifies a display object that is used as the visual object for the button down state - the state that the button is in when the user selects the hitTestState object.
read / write
enabled bool
Specifies whether a button is enabled.
read / write
filters List<BitmapFilter>
The filters currently associated with this display object.
read / writeinherited
globalTransformationMatrix Matrix
The global 2D transformation matrix of this display object.
read-onlyinherited
globalTransformationMatrix3D Matrix3D
The global 3D transformation matrix of this display object.
read-onlyinherited
hashCode int
The hash code for this object.
read-onlyinherited
height num
The height of this display object with the applied transformation.
read / writeinherited
hitTestState DisplayObject?
Specifies a display object that is used as the hit testing object for the button.
read / write
mask Mask?
The calling display object is masked by the specified mask object.
read / writeinherited
mouseCursor String
Defines the mouse cursor that is displayed on this interactive object.
read / writeinherited
mouseEnabled bool
Specifies whether this object receives mouse, or other user input, messages.
read / writeinherited
mousePosition Point<num>?
The position of the mouse relative to the local coordinate system of the display object.
read-onlyinherited
mouseX num
The x-coordinate of the mouse relative to the local coordinate system of the display object.
read-onlyinherited
mouseY num
The y-coordinate of the mouse relative to the local coordinate system of the display object.
read-onlyinherited
name String
The instance name of this display object.
read / writeinherited
off bool
The availability and visibility of the display object.
read / writeinherited
onAdded EventStream<Event>
Dispatched when a display object is added to the display list.
read-onlyinherited
onAddedToStage EventStream<Event>
Dispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained.
read-onlyinherited
onEnterFrame EventStream<EnterFrameEvent>
Dispatched when a frame is entered.
read-onlyinherited
onExitFrame EventStream<ExitFrameEvent>
Dispatched when a frame is exited. All frame scripts have been run.
read-onlyinherited
onKeyDown EventStream<KeyboardEvent>
Dispatched when the user presses a key.
read-onlyinherited
onKeyUp EventStream<KeyboardEvent>
Dispatched when the user releases a key.
read-onlyinherited
onMouseClick EventStream<MouseEvent>
Dispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject.
read-onlyinherited
onMouseContextMenu EventStream<MouseEvent>
Dispatched when a user gesture triggers the context menu associated with this interactive object.
read-onlyinherited
onMouseDoubleClick EventStream<MouseEvent>
Dispatched when a user presses and releases the main button of a pointing device twice in rapid succession over the same InteractiveObject when that object's doubleClickEnabled flag is set to true.
read-onlyinherited
onMouseDown EventStream<MouseEvent>
Dispatched when a user presses the pointing device button over an InteractiveObject instance.
read-onlyinherited
onMouseMiddleClick EventStream<MouseEvent>
Dispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject.
read-onlyinherited
onMouseMiddleDown EventStream<MouseEvent>
Dispatched when a user presses the middle pointing device button over an InteractiveObject instance.
read-onlyinherited
onMouseMiddleUp EventStream<MouseEvent>
Dispatched when a user releases the pointing device button over an InteractiveObject instance.
read-onlyinherited
onMouseMove EventStream<MouseEvent>
Dispatched when a user moves the pointing device while it is over an InteractiveObject.
read-onlyinherited
onMouseOut EventStream<MouseEvent>
Dispatched when the user moves a pointing device away from an InteractiveObject instance.
read-onlyinherited
onMouseOver EventStream<MouseEvent>
Dispatched when the user moves a pointing device over an InteractiveObject instance.
read-onlyinherited
onMouseRightClick EventStream<MouseEvent>
Dispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject.
read-onlyinherited
onMouseRightDown EventStream<MouseEvent>
Dispatched when a user presses the right button over an InteractiveObject instance.
read-onlyinherited
onMouseRightUp EventStream<MouseEvent>
Dispatched when a user releases the right button over an InteractiveObject instance.
read-onlyinherited
onMouseRollOut EventStream<MouseEvent>
Dispatched when the user moves a pointing device away from an InteractiveObject instance.
read-onlyinherited
onMouseRollOver EventStream<MouseEvent>
Dispatched when the user moves a pointing device over an InteractiveObject instance.
read-onlyinherited
onMouseUp EventStream<MouseEvent>
Dispatched when a user releases the pointing device button over an InteractiveObject instance.
read-onlyinherited
onMouseWheel EventStream<MouseEvent>
Dispatched when a mouse wheel is spun over an InteractiveObject instance.
read-onlyinherited
onRemoved EventStream<Event>
Dispatched when a display object is about to be removed from the display list.
read-onlyinherited
onRemovedFromStage EventStream<Event>
Dispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained.
read-onlyinherited
onRender EventStream<RenderEvent>
Dispatched when the display list is about to be updated and rendered.
read-onlyinherited
onTextInput EventStream<TextEvent>
Dispatched when a user enters one or more characters of text.
read-onlyinherited
onTouchBegin EventStream<TouchEvent>
Dispatched when the user first contacts a touch-enabled device.
read-onlyinherited
onTouchCancel EventStream<TouchEvent>
Dispatched when the touch event is canceled.
read-onlyinherited
onTouchEnd EventStream<TouchEvent>
Dispatched when the user removes contact with a touch-enabled device.
read-onlyinherited
onTouchMove EventStream<TouchEvent>
Dispatched when the user touches the device, and is continuously dispatched until the point of contact is removed.
read-onlyinherited
onTouchOut EventStream<TouchEvent>
Dispatched when the user moves the point of contact away from InteractiveObject instance on a touch-enabled device.
read-onlyinherited
onTouchOver EventStream<TouchEvent>
Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device.
read-onlyinherited
onTouchRollOut EventStream<TouchEvent>
Dispatched when the user moves the point of contact away from an InteractiveObject instance on a touch-enabled device.
read-onlyinherited
onTouchRollOver EventStream<TouchEvent>
Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device.
read-onlyinherited
onTouchTap EventStream<TouchEvent>
Dispatched when the user lifts the point of contact over the same InteractiveObject instance on which the contact was initiated on a touch-enabled device.
read-onlyinherited
overState DisplayObject?
Specifies a display object that is used as the visual object for the button over state — the state that the button is in when the pointer is positioned over the button.
read / write
parent DisplayObjectParent<DisplayObject>?
The DisplayObjectContainer object that contains this display object.
read-onlyinherited
pivotX num
The x-coordinate of the pivot point of this display object.
read / writeinherited
pivotY num
The y-coordinate of the pivot point of this display object.
read / writeinherited
root DisplayObject
The top-most display object in the portion of the display list's tree structure.
read-onlyinherited
rotation num
The rotation of this display object, in radians, from its original orientation.
read / writeinherited
runtimeType Type
A representation of the runtime type of the object.
read-onlyinherited
scaleX num
The horizontal scale (percentage) of the object as applied from the pivot point.
read / writeinherited
scaleY num
The vertical scale (percentage) of the object as applied from the pivot point.
read / writeinherited
skewX num
The horizontal skew of this object.
read / writeinherited
skewY num
The vertical skew of this object.
read / writeinherited
stage Stage?
The Stage of this display object.
read-onlyinherited
state SimpleButtonState
The current state of the button (Up, Over, Down).
read-only
tabEnabled bool
Specifies whether this object is in the tab order.
read / writeinherited
tabIndex int
Specifies the tab ordering of objects.
read / writeinherited
transformationMatrix Matrix
The transformation matrix of this display object relative to this display object's parent.
read-onlyinherited
upState DisplayObject?
Specifies a display object that is used as the visual object for the button up state — the state that the button is in when the pointer is not positioned over the button.
read / write
useHandCursor bool
read / writeinherited
userData ↔ dynamic
The user-defined data associated with this display object.
read / writeinherited
visible bool
The visibility and availability of the display object.
read / writeinherited
width num
The width of this display object with the applied transformation.
read / writeinherited
x num
The x-coordinate of is display object relative to the local coordinates of the parent DisplayObjectContainer.
read / writeinherited
y num
The y-coordinate of this display object relative to the local coordinates of the parent DisplayObjectContainer.
read / writeinherited

Methods

addEventListener<T extends Event>(String eventType, EventListener<T> eventListener, {bool useCapture = false, int priority = 0}) StreamSubscription<T>
Adds an event listener to receive events.
inherited
addTo(DisplayObjectParent<DisplayObject> parent) → void
Add this display object to the specified parent.
inherited
alignPivot([HorizontalAlign hAlign = HorizontalAlign.Center, VerticalAlign vAlign = VerticalAlign.Center]) → void
Aligns the display object's pivot point relative to the current bounds.
inherited
applyCache(num x, num y, num width, num height, {bool debugBorder = false, num pixelRatio = 1.0}) → void
Draws the specified area of this display object to an internal render texture and the engine will use this texture to optimize performance.
inherited
dispatchEvent(Event event) → void
Dispatches the event to all listening subscribers.
inherited
dispatchEventRaw(Event event, EventDispatcher target, EventPhase eventPhase) → void
Do not use the dispatchEventRaw method unless you want to override the way how events are dispatched for display list object. Please use dispatchEvent instead.
inherited
getBounds(DisplayObject targetSpace) Rectangle<num>
Returns the bounds of this display object relative to the specified targetSpace.
inherited
getTransformationMatrix(DisplayObject targetSpace) Matrix
The 2D transformation matrix relative to the given targetSpace.
inherited
getTransformationMatrix3D(DisplayObject targetSpace) Matrix3D
The 3D transformation matrix relative to the given targetSpace.
inherited
globalToLocal(Point<num> globalPoint, [Point<num>? returnPoint]) Point<num>
Converts the point object from the Stage's global coordinates to this display object's local coordinates.
inherited
hasEventListener(String eventType, {bool useCapture = false}) bool
Returns true if the EventDispatcher has event listeners. The useCapture paramenter defines if the event listeners should be registered for the capturing event phase or not.
inherited
hitTestInput(num localX, num localY) DisplayObject?
Evaluates this display object to see if the coordinates localX and localY are inside this display object.
override
hitTestObject(DisplayObject other) bool
Evaluates this display object to see if it overlaps or intersects with the bounding box of the other display object.
inherited
hitTestPoint(num x, num y, [bool shapeFlag = false]) bool
Evaluates this display object to see if it overlaps or intersects with the point specified by the x and y parameters.
inherited
localToGlobal(Point<num> localPoint, [Point<num>? returnPoint]) Point<num>
Converts the point object from this display object's local coordinates to the Stage global coordinates.
inherited
localToParent(Point<num> localPoint, [Point<num>? returnPoint]) Point<num>
Converts the point object from this display object's local coordinates to this display object's parent coordinates.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
on<T extends Event>(String eventType) EventStream<T>
Returns an event stream of type eventType.
inherited
parentToLocal(Point<num> parentPoint, [Point<num>? returnPoint]) Point<num>
Converts the point object from this display object's parent coordinates to this display object's local coordinates.
inherited
refreshCache() → void
Refreshes the cached area of this display object.
inherited
removeCache() → void
Removes the previously cached area of this display object.
inherited
removeEventListener<T extends Event>(String eventType, EventListener<T> eventListener, {bool useCapture = false}) → void
Removes an event listener to stop receiving events.
inherited
removeEventListeners(String eventType) → void
Removes all event listeners of a given event type.
inherited
removeFromParent() → void
Removes this display object from its parent.
inherited
render(RenderState renderState) → void
Renders this display object with the given renderState. The display object is rendered without its filters.
override
renderFiltered(RenderState renderState) → void
Renders this display object with the given renderState. The display object is rendered with its filters.
inherited
setTransform(num x, num y, [num scaleX = 1, num scaleY = 1, num rotation = 0, num skewX = 0, num skewY = 0, num pivotX = 0, num pivotY = 0]) → void
Sets transformation properties.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited