public class

ImageButton

extends View

java.lang.Object
↳	com.neomades.ui.View
	↳	com.neomades.ui.ImageButton

Class Overview

Control that displays an Image as a Button. ImageButton could have many images for different states of a Button.

Handling click events

Default properties

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

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.

Summary

XML Attributes
Attribute Name	Related Method	Description
image	setImage(Image)	Res.image.XXXX or a color
imageDisabled	setImageDisabled(Image)	Res.image.XXXX or a color
imageFocused	setImageFocused(int)	Res.image.XXXX or a color
imagePressed	setImagePressed(int)	Res.image.XXXX or a color

[Expand]

Inherited XML Attributes

From class com.neomades.ui.View

[Expand]

Inherited Constants

From interface com.neomades.ui.Alignment

From interface com.neomades.ui.StretchMode

Public Constructors
	ImageButton() Creates a new Button.
	ImageButton(Image img) Creates a new Button with only an image.
	ImageButton(int resId) Creates a new Button with only an image.

Public Methods
void	setImage(int resId) Sets the image.
void	setImage(Image image) Sets the image.
void	setImageDisabled(int image) Sets the disabled image.
void	setImageDisabled(Image image)
void	setImageFocused(Image image)
void	setImageFocused(int image) Sets the focused image.
void	setImagePressed(Image image)
void	setImagePressed(int image) Sets the pressed image.
void	setImageScaleType(int scaleType) Set the scale type for the image contained into this button.

[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.

XML Attributes

image

Res.image.XXXX or a color

Related Methods

setImage(Image)

imageDisabled

Res.image.XXXX or a color

Related Methods

setImageDisabled(Image)

imageFocused

Res.image.XXXX or a color

Related Methods

setImageFocused(int)

imagePressed

Res.image.XXXX or a color

Related Methods

setImagePressed(int)

Public Constructors

public ImageButton ()

Creates a new Button.

public ImageButton (Image img)

Creates a new Button with only an image.

Parameters

img	the image to display

public ImageButton (int resId)

Creates a new Button with only an image.

Parameters

resId	the image to display

Public Methods

public void setImage (int resId)

Sets the image.

Related XML Attributes

image

Parameters

resId	the image to show

Throws

CrossThreadException	if this method call is done in the wrong Thread.
CrossThreadException	if the method is called from outside the UI-Thread

public void setImage (Image image)

Sets the image.

Related XML Attributes

image

Parameters

image	the image to show.

Throws

CrossThreadException	if this method call is done in the wrong Thread.
CrossThreadException	if the method is called from outside the UI-Thread

public void setImageDisabled (int image)

Sets the disabled image.

Related XML Attributes

imageDisabled

Parameters

image	the image to show when the button is disabled

Throws

CrossThreadException	if this method call is done in the wrong Thread.
CrossThreadException	if the method is called from outside the UI-Thread

public void setImageDisabled (Image image)

Related XML Attributes

imageDisabled

Throws

CrossThreadException	if this method call is done in the wrong Thread.
CrossThreadException	if the method is called from outside the UI-Thread

public void setImageFocused (Image image)

Related XML Attributes

imageFocused

Throws

CrossThreadException	if this method call is done in the wrong Thread.
CrossThreadException	if the method is called from outside the UI-Thread

public void setImageFocused (int image)

Sets the focused image.

Related XML Attributes

imageFocused

Parameters

image	the image to show when the button is focused

Throws

CrossThreadException	if this method call is done in the wrong Thread.
CrossThreadException	if the method is called from outside the UI-Thread

public void setImagePressed (Image image)

Related XML Attributes

imagePressed

Throws

CrossThreadException	if this method call is done in the wrong Thread.
CrossThreadException	if the method is called from outside the UI-Thread

public void setImagePressed (int image)

Sets the pressed image.

Related XML Attributes

imagePressed

Parameters

image	the image to show when the button is pressed

Throws

CrossThreadException	if this method call is done in the wrong Thread.
CrossThreadException	if the method is called from outside the UI-Thread

public void setImageScaleType (int scaleType)

Set the scale type for the image contained into this button.

By default, the scale type is STRETCH.

Parameters

scaleType	the scale type to apply to the image of the ImageButton

Interfaces

Classes

Enums

Exceptions

ImageButton

Class Overview

Handling click events

Default properties

See Also

Summary

XML Attributes

image

Related Methods

imageDisabled

Related Methods

imageFocused

Related Methods

imagePressed

Related Methods

Public Constructors

public ImageButton ()

See Also

public ImageButton (Image img)

Parameters

See Also

public ImageButton (int resId)

Parameters

See Also

Public Methods

public void setImage (int resId)

Related XML Attributes

Parameters

Throws

See Also

public void setImage (Image image)

Related XML Attributes

Parameters

Throws

See Also

public void setImageDisabled (int image)

Related XML Attributes

Parameters

Throws

See Also

public void setImageDisabled (Image image)

Related XML Attributes

Throws

See Also

public void setImageFocused (Image image)

Related XML Attributes

Throws

See Also

public void setImageFocused (int image)

Related XML Attributes

Parameters

Throws

See Also

public void setImagePressed (Image image)

Related XML Attributes

Throws

See Also

public void setImagePressed (int image)

Related XML Attributes

Parameters

Throws

See Also

public void setImageScaleType (int scaleType)

Parameters

See Also