Button

Class Overview

A Button represents a button into screen in order to intercept events (touch and keys).

Handling click events

A typical use of Button could be :

 ClickListener clickListener = new ClickListener() {
 	public void onClick(View view) {
 		// do some stuff
 	}
 };
 Button myButton = new Button("Text of the button");
 myButton.setClickListener(clickListener);
 layout.addView(myButton);
 

By default, the following properties are applied to a new Button:

• focusable (limited to some devices)
• clickable
• enabled
• no text
• no icon
• width content stretch : MATCH_PARENT.
• height content stretch : MATCH_CONTENT.
• content alignment : HCENTER|VCENTER.

Cross Platform Considerations

In Android, a Button is a android.widget.Button. It will contain text. Use background methods (such as setBackgroundImage(int)) to customize the visual aspect.

In iOS, a Button is a UIButton with style UIButtonStyleRoundedRect. This default style will represent the Button as a button with rounded corners. Using a customized background will replace the default style (the default border and lines will be hidden).

Summary

[Expand] Inherited XML Attributes

From class com.neomades.ui.View Attribute Name Related Method Description background setBackground(int) Res.background.XXXX   backgroundColor setBackgroundColor(Color) #AARRGGBB or a color   backgroundImage setBackgroundImage(Image) Res.image.XXXX or a color   borderColor setBorderColor(Color) #AARRGGBB or a color   borderWidth setBorderWidth(int) eg: 10dp or 10 (dp is the default unit)   clickable setClickable(boolean) If the view could be clicked   cornerRadius setCornerRadius(int) eg: 10dp or 10 (dp is the default unit)   enabled setEnabled(boolean) If the view could be enabled   focusable setFocusable(boolean) If the view could be focused   height setHeight(int) eg: 10dp or 10 (dp is the default unit)   id setId(int) Res.id.XXXX   layoutAlignment setLayoutAlignment(int) A combination of alignment values (eg: TOP|LEFT)   margin setMargin(int) eg: 10dp or 10 (dp is the default unit)   marginBottom setMarginBottom(int) eg: 10dp or 10 (dp is the default unit)   marginLeft setMarginLeft(int) eg: 10dp or 10 (dp is the default unit)   marginRight setMarginRight(int) eg: 10dp or 10 (dp is the default unit)   marginTop setMarginTop(int) eg: 10dp or 10 (dp is the default unit)   padding setPadding(int) eg: 10dp or 10 (dp is the default unit)   paddingBottom setPaddingBottom(int) eg: 10dp or 10 (dp is the default unit)   paddingLeft setPaddingLeft(int) eg: 10dp or 10 (dp is the default unit)   paddingRight setPaddingRight(int) eg: 10dp or 10 (dp is the default unit)   paddingTop setPaddingTop(int) eg: 10dp or 10 (dp is the default unit)   stretchHorizontalMode setStretchHorizontalMode(int) The dimension could be adapted to the parent dimension or to the content size.  stretchVerticalMode setStretchVerticalMode(int) The dimension could be adapted to the parent dimension or to the content size.  visible setVisible(boolean) If the view is visible or hidden and collapsed   width setWidth(int) eg: 10dp or 10 (dp is the default unit)

[Expand] Inherited Constants
From interface com.neomades.ui.Alignment int BOTTOM Vertical bottom int HCENTER Horizontal center int LEFT Horizontal left int RIGHT Horizontal right int TOP Vertical top int VCENTER Vertical center or middle
From interface com.neomades.ui.StretchMode int MATCH_CONTENT The view will get the size of its content int MATCH_PARENT The view will fill the size of its parent

[Expand] Inherited Methods
From class com.neomades.ui.View View findView(int viewId) Find view by Id. int getId() Returns the identifier of this element, by default all elements return "0". Object getTag() Returns this view's tag. static View inflateXML(int layoutResId) Inflate view from XMLLayout declared in the URS File. static View inflateXML(InputStream xmlStream) @return boolean isClickable() Returns if the view is clickable. boolean isEnabled() Return a boolean indicating if the view is enabled or not boolean isFocusable() Returns if the view is focusable (for the devices that have a keyboard Ui navigation). boolean isVisible() Returns if the view is visible void runOnUiThread(Runnable action) Calls action.run() asynchronously on the UI-Thread. void setBackground(Background background) Sets the background on this view. void setBackground(int backgroundResId) Sets the background on this view with a XML background definition. void setBackgroundColor(Color color) Sets the background color on this view. void setBackgroundImage(int imageID) Set the background image for this view. void setBackgroundImage(Image image) Set the background image for this view. void setBorderColor(Color borderColor) Sets the border color on this view. void setBorderWidth(int widthInDp) Set the border width (size) in DP units. void setClickListener(ClickListener clickListener) Sets a ClickListener to this view. void setClickable(boolean clickable) Sets this view clickable. void setCornerRadius(int radiusSize) Set the four corners radius, if the view has corners. void setDrawingCacheEnabled(boolean enabled) Enables or disables the drawing cache. void setEnabled(boolean enabled) Sets the state of this view to enabled or disabled. void setFocusable(boolean focusable) Sets the view focusable. void setGestureDetector(GestureDetector detector) Sets a GestureDetector on this view. void setHeight(int heightDp) Sets the height of the view, in dp units (density-independent pixels). void setId(int id) Sets a identifier/tag to this element void setInvalidateDisabled(boolean disabled) If set to true, force the layout that contains the view to not be draw again when its content changes. void setLayoutAlignment(int alignment) Sets the view alignment into its parent. void setMargin(int uniformMarginDp) Set the margin outside this view (used by Layout), by setting on each side the given value. void setMargin(int leftDp, int topDp, int rightDp, int bottomDp) Set the margin outside this view (used by Layout). void setMarginBottom(int marginBottomDp) Sets the bottom margin with the given value. void setMarginLeft(int marginLeftDp) Sets the left margin with the given value. void setMarginRight(int marginRightDp) Sets the right margin with the given value. void setMarginTop(int marginTopDp) Sets the top margin with the given value. void setPadding(int leftDp, int topDp, int rightDp, int bottomDp) Sets the view padding. void setPadding(int uniformPaddingDp) Sets the view padding, with for each side the value given in parameter. void setPaddingBottom(int paddingBottomDp) Sets the bottom padding with the given value. void setPaddingLeft(int paddingLeftDp) Sets the left padding with the given value. void setPaddingRight(int paddingRightDp) Sets the right padding with the given value. void setPaddingTop(int paddingTopDp) Sets the top padding with the given value. void setSize(int widthDp, int heightDp) Sets the size of the view, in dp units (density-independent pixels). void setStretchHorizontalMode(int widthMode) Sets the stretch horizontal mode. void setStretchMode(int horizontalMode, int verticalMode) Sets the view content stretch mode. void setStretchVerticalMode(int heightMode) Sets the stretch vertical mode. void setStyle(int styleResId) void setStyle(Style style) void setTag(Object tag) Sets the tag associated with this view. void setTouchListener(TouchListener touchListener) Register a listener to be invoked when a touch event is dispatched to this view. void setTransformOrigin(float xOrigin, float yOrigin) Sets the x and y location of the point around which the view will be scaled or rotated when an animation occurs. void setVisible(boolean visible) Sets the view's visibility : visible or invisible/hidden void setWidth(int widthDp) Sets the width of the view, in dp units (density-independent pixels).
From class java.lang.Object boolean equals(Object obj) Indicates whether some other object is "equal to" this one. final Class<?> getClass() Returns the runtime class of an object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeout, int nanos) Causes current thread to wait until another thread invokes the notify() method or the notifyAll() method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed. final void wait(long timeout) Causes current thread to wait until either another thread invokes the notify() method or the notifyAll() method for this object, or a specified amount of time has elapsed. final void wait() Causes current thread to wait until another thread invokes the notify() method or the notifyAll() method for this object.