Class ImageViewer

java.lang.Object

com.codename1.ui.Component

com.codename1.components.ImageViewer

All Implemented Interfaces:

Animation, Editable, StyleListener

public class ImageViewer
extends Component

ImageViewer allows zooming/panning an image and potentially flicking between multiple images within a list of images.

E.g. the trivial usage works like this:

Form hi = new Form("ImageViewer", new BorderLayout());
ImageViewer iv = new ImageViewer(duke);
hi.add(BorderLayout.CENTER, iv);

You can simulate pinch to zoom on the simulator by dragging the right button away from the top left corner to zoom in and towards the top left corner to zoom out. On Mac touchpads you can drag two fingers to achieve that.

A more elaborate usage includes flicking between multiple images e.g.:

Form hi = new Form("ImageViewer", new BorderLayout());

Image red = Image.createImage(100, 100, 0xffff0000);
Image green = Image.createImage(100, 100, 0xff00ff00);
Image blue = Image.createImage(100, 100, 0xff0000ff);
Image gray = Image.createImage(100, 100, 0xffcccccc);

ImageViewer iv = new ImageViewer(red);
iv.setImageList(new DefaultListModel<>(red, green, blue, gray));
hi.add(BorderLayout.CENTER, iv);

Optional navigation affordances can be enabled when using an image list:

iv.setNavigationArrowsVisible(true);
iv.setThumbnailsVisible(true);
iv.setThumbnailBarHeight(6f);

These options can also be configured globally using theme constants:

• imageviewerNavigationArrowsBool
• imageviewerThumbnailsBool
• imageviewerThumbnailBarHeightMM

You can even download image URL's dynamically into the ImageViewer thanks to the usage of the com.codename1.ui.list.ListModel. E.g. in this model book cover images are downloaded dynamically:

Form hi = new Form("ImageViewer", new BorderLayout());
final EncodedImage placeholder = EncodedImage.createFromImage(
        FontImage.createMaterial(FontImage.MATERIAL_SYNC, s).
                scaled(300, 300), false);

class ImageList implements ListModel {
    private int selection;
    private String[] imageURLs = {
        "http://awoiaf.westeros.org/images/thumb/9/93/AGameOfThrones.jpg/300px-AGameOfThrones.jpg",
        "http://awoiaf.westeros.org/images/thumb/3/39/AClashOfKings.jpg/300px-AClashOfKings.jpg",
        "http://awoiaf.westeros.org/images/thumb/2/24/AStormOfSwords.jpg/300px-AStormOfSwords.jpg",
        "http://awoiaf.westeros.org/images/thumb/a/a3/AFeastForCrows.jpg/300px-AFeastForCrows.jpg",
        "http://awoiaf.westeros.org/images/7/79/ADanceWithDragons.jpg"
    };
    private Image[] images;
    private EventDispatcher listeners = new EventDispatcher();

    public ImageList() {
        this.images = new EncodedImage[imageURLs.length];
    }

    public Image getItemAt(final int index) {
        if(images[index] == null) {
            images[index] = placeholder;
            Util.downloadUrlToStorageInBackground(imageURLs[index], "list" + index, (e) -> {
                    try {
                        images[index] = EncodedImage.create(Storage.getInstance().createInputStream("list" + index));
                        listeners.fireDataChangeEvent(index, DataChangedListener.CHANGED);
                    } catch(IOException err) {
                        err.printStackTrace();
                    }
            });
        }
        return images[index];
    }

    public int getSize() {
        return imageURLs.length;
    }

    public int getSelectedIndex() {
        return selection;
    }

    public void setSelectedIndex(int index) {
        selection = index;
    }

    public void addDataChangedListener(DataChangedListener l) {
        listeners.addListener(l);
    }

    public void removeDataChangedListener(DataChangedListener l) {
        listeners.removeListener(l);
    }

    public void addSelectionListener(SelectionListener l) {
    }

    public void removeSelectionListener(SelectionListener l) {
    }

    public void addItem(Image item) {
    }

    public void removeItem(int index) {
    }
};

ImageList imodel = new ImageList();

ImageViewer iv = new ImageViewer(imodel.getItemAt(0));
iv.setImageList(imodel);
hi.add(BorderLayout.CENTER, iv);

Field Summary

Fields

Modifier and Type	Field	Description
static final int	IMAGE_FILL	Indicates the initial position of the image in the viewer to FILL the component size.
static final int	IMAGE_FIT	Indicates the initial position of the image in the viewer to FIT to the component size

Fields inherited from class Component

BASELINE, BOTTOM, BRB_CENTER_OFFSET, BRB_CONSTANT_ASCENT, BRB_CONSTANT_DESCENT, BRB_OTHER, CENTER, CROSSHAIR_CURSOR, DEFAULT_CURSOR, DRAG_REGION_IMMEDIATELY_DRAG_X, DRAG_REGION_IMMEDIATELY_DRAG_XY, DRAG_REGION_IMMEDIATELY_DRAG_Y, DRAG_REGION_LIKELY_DRAG_X, DRAG_REGION_LIKELY_DRAG_XY, DRAG_REGION_LIKELY_DRAG_Y, DRAG_REGION_NOT_DRAGGABLE, DRAG_REGION_POSSIBLE_DRAG_X, DRAG_REGION_POSSIBLE_DRAG_XY, DRAG_REGION_POSSIBLE_DRAG_Y, E_RESIZE_CURSOR, HAND_CURSOR, LEFT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NW_RESIZE_CURSOR, RIGHT, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, TOP, W_RESIZE_CURSOR, WAIT_CURSOR

Modifier and Type	Field	Description
static final int	BASELINE	Alignment to the baseline constraint
static final int	BOTTOM	Box-orientation constant used to specify the bottom of a box.
static final int	BRB_CENTER_OFFSET	Baseline resize behavior constant used to properly align components.
static final int	BRB_CONSTANT_ASCENT	Baseline resize behavior constant used to properly align components.
static final int	BRB_CONSTANT_DESCENT	Baseline resize behavior constant used to properly align components.
static final int	BRB_OTHER	Baseline resize behavior constant used to properly align components.
static final int	CENTER	Indicates a Component center alignment
static final int	CROSSHAIR_CURSOR	The crosshair cursor type.
static final int	DEFAULT_CURSOR	The default cursor
static final int	DRAG_REGION_IMMEDIATELY_DRAG_X	Used by getDragRegionStatus to indicate immediate dragability
static final int	DRAG_REGION_IMMEDIATELY_DRAG_XY	Used by getDragRegionStatus to indicate immediate dragability
static final int	DRAG_REGION_IMMEDIATELY_DRAG_Y	Used by getDragRegionStatus to indicate immediate dragability
static final int	DRAG_REGION_LIKELY_DRAG_X	Used by getDragRegionStatus to indicate likely dragability
static final int	DRAG_REGION_LIKELY_DRAG_XY	Used by getDragRegionStatus to indicate likely dragability
static final int	DRAG_REGION_LIKELY_DRAG_Y	Used by getDragRegionStatus to indicate likely dragability
static final int	DRAG_REGION_NOT_DRAGGABLE	Used by getDragRegionStatus to indicate no dragability
static final int	DRAG_REGION_POSSIBLE_DRAG_X	Used by getDragRegionStatus to indicate limited dragability
static final int	DRAG_REGION_POSSIBLE_DRAG_XY	Used by getDragRegionStatus to indicate limited dragability
static final int	DRAG_REGION_POSSIBLE_DRAG_Y	Used by getDragRegionStatus to indicate limited dragability
static final int	E_RESIZE_CURSOR	The east-resize cursor type.
static final int	HAND_CURSOR	The hand cursor type.
static final int	LEFT	Box-orientation constant used to specify the left side of a box.
static final int	MOVE_CURSOR	The move cursor type.
static final int	N_RESIZE_CURSOR	The north-resize cursor type.
static final int	NE_RESIZE_CURSOR	The north-east-resize cursor type.
static final int	NW_RESIZE_CURSOR	The north-west-resize cursor type.
static final int	RIGHT	Box-orientation constant used to specify the right side of a box.
static final int	S_RESIZE_CURSOR	The south-resize cursor type.
static final int	SE_RESIZE_CURSOR	The south-east-resize cursor type.
static final int	SW_RESIZE_CURSOR	The south-west-resize cursor type.
static final int	TEXT_CURSOR	The text cursor type.
static final int	TOP	Box-orientation constant used to specify the top of a box.
static final int	W_RESIZE_CURSOR	The west-resize cursor type.
static final int	WAIT_CURSOR	The wait cursor type.

Constructor Summary

Constructors

Constructor	Description
ImageViewer()	Default constructor
ImageViewer(Image i)	Initializes the component with an image

Method Summary

Modifier and Type	Method	Description
boolean	animate()	Allows the animation to reduce "repaint" calls when it returns false.
protected Dimension	calcPreferredSize()	Calculates the preferred size based on component content.
void	deinitialize()	Invoked to indicate that the component initialization is being reversed since the component was detached from the container hierarchy.
protected void	dragFinished(int x, int y)	Callback indicating that the drag has finished either via drop or by releasing the component
Image	getCroppedImage(int backgroundColor)	Gets the current image cropped using the current pan and zoom state.
Image	getCroppedImage(int width, int height, int backgroundColor)	Gets the current image cropped using the current pan and zoom state.
Image	getImage()	Returns the currently showing image
ListModel<Image>	getImageList()	Returns the list model containing the images in the we can swipe through
int	getImageX()	Returns the x position of the image viewport which can be useful when it is being panned by the user
int	getImageY()	Returns the y position of the image viewport which can be useful when it is being panned by the user
String[]	getPropertyNames()	A component may expose mutable property names for a UI designer to manipulate, this API is designed for usage internally by the GUI builder code
String[]	getPropertyTypeNames()	This method is here to workaround an XMLVM array type bug where property types aren't identified properly, it returns the names of the types using the following type names: String,int,double,long,byte,short,char,String[],String[][],byte[],Image,Image[],Object[],ListModel,ListCellRenderer
Class[]	getPropertyTypes()	Matches the property names method (see that method for further details).
Object	getPropertyValue(String name)	Returns the current value of the property name, this method is used by the GUI builder
Image	getSwipePlaceholder()	This image is shown briefly during swiping while the full size image is loaded
float	getSwipeThreshold()	The swipe threshold is a number between 0 and 1 that indicates the threshold after which the swiped image moves to the next image.
float	getThumbnailBarHeight()	Gets the thumbnail strip height in millimeters.
float	getZoom()	Manipulate the zoom level of the application
void	initComponent()	Allows subclasses to bind functionality that relies on fully initialized and "ready for action" component state
boolean	isAllowScaleDown()	Allows the image to scale down when image initial position is set to fit this is off by default since the UX isn't great
boolean	isAnimatedZoom()	Indicates if the zoom should bee animated.
boolean	isCycleLeft()	By default the ImageViewer cycles from the beginning to the end of the list when going to the left, setting this to false prevents this behaviour
boolean	isCycleRight()	By default the ImageViewer cycles from the end to the beginning of the list when going to the right, setting this to false prevents this behaviour
boolean	isEagerLock()	Eager locking effectively locks the right/left images as well as the main image, as a result more heap is taken
boolean	isNavigationArrowsVisible()	Indicates if side navigation arrows should be painted for moving between images.
boolean	isThumbnailsVisible()	Indicates if thumbnails should be painted in a strip at the bottom for direct image selection.
void	keyReleased(int key)	If this Component is focused, the key released event will call this method
protected void	laidOut()	This is a callback method to inform the Component when it's been laidout on the parent Container
void	paint(Graphics g)	This method paints the Component on the screen, it should be overriden by subclasses to perform custom drawing or invoke the UI API's to let the PLAF perform the rendering.
protected void	paintBackground(Graphics g)	This method paints the Component background, it should be overriden by subclasses to perform custom background drawing.
protected boolean	pinch(float scale)	Invoked by subclasses interested in handling pinch to zoom events, if true is returned other drag events will not be broadcast
protected void	pinchReleased(int x, int y)	To be implemented by subclasses interested in being notified when a pinch zoom has ended (i.e the user has removed one of their fingers, but is still dragging).
void	pointerDragged(int x, int y)	If this Component is focused, the pointer dragged event will call this method
void	pointerPressed(int x, int y)	If this Component is focused, the pointer pressed event will call this method
void	pointerReleased(int x, int y)	If this Component is focused, the pointer released event will call this method
protected void	resetFocusable()	Restores the state of the focusable flag to its default state
void	setAllowScaleDown(boolean allowScaleDown)	Allows the image to scale down when image initial position is set to fit this is off by default since the UX isn't great
void	setAnimateZoom(boolean animateZoom)	Indicates if the zoom should bee animated.
void	setCycleLeft(boolean cycleLeft)	By default the ImageViewer cycles from the beginning to the end of the list when going to the left, setting this to false prevents this behaviour
void	setCycleRight(boolean cycleRight)	By default the ImageViewer cycles from the end to the beginning of the list when going to the right, setting this to false prevents this behaviour
void	setEagerLock(boolean eagerLock)	Eager locking effectively locks the right/left images as well as the main image, as a result more heap is taken
final void	setImage(Image image)	Sets the currently showing image
void	setImageInitialPosition(int imageInitialPosition)	Sets the viewer initial image position to fill or to fit.
void	setImageList(ListModel<Image> model)	By providing this optional list of images you can allows swiping between multiple images
void	setImageNoReposition(Image image)	Sets the current image without any changes to the panning/scaling
void	setNavigationArrowsVisible(boolean navigationArrowsVisible)	Enables side navigation arrows (material font icons) for moving between images.
String	setPropertyValue(String name, Object value)	Sets a new value to the given property, returns an error message if failed and null if successful.
void	setSwipePlaceholder(Image swipePlaceholder)	This image is shown briefly during swiping while the full size image is loaded
void	setSwipeThreshold(float swipeThreshold)	The swipe threshold is a number between 0 and 1 that indicates the threshold after which the swiped image moves to the next image.
void	setThumbnailBarHeight(float thumbnailBarHeight)	Sets the thumbnail strip height in millimeters.
void	setThumbnailsVisible(boolean thumbnailsVisible)	Enables a bottom thumbnail strip for direct image selection.
void	setZoom(float zoom)	Manipulate the zoom level of the application
void	setZoom(float zoom, float panPositionX, float panPositionY)	Manipulate the zoom level of the application
protected boolean	shouldBlockSideSwipe()	A component that might need side swipe such as the slider could block it from being used for some other purpose when on top of said component.

Methods inherited from class Component

addDragFinishedListener, addDragOverListener, addDropListener, addFocusListener, addLongPressListener, addPointerDraggedListener, addPointerPressedListener, addPointerReleasedListener, addPullToRefresh, addScrollListener, addStateChangeListener, announceForAccessibility, bindProperty, blocksSideSwipe, calcScrollSize, cancelRepaints, clearClientProperties, contains, containsOrOwns, createStyleAnimation, deinitializeCustomStyle, dragEnter, dragExit, draggingOver, dragInitiated, drawDraggedImage, drop, fireClicked, focusGained, focusLost, getAbsoluteX, getAbsoluteY, getAccessibilityText, getAllStyles, getAnimationManager, getBaseline, getBaselineResizeBehavior, getBindablePropertyNames, getBindablePropertyTypes, getBorder, getBottomGap, getBoundPropertyValue, getBounds, getBounds, getClientProperty, getCloudBoundProperty, getCloudDestinationProperty, getComponentForm, getComponentState, getCursor, getDefaultDragTransparency, getDirtyRegion, getDisabledStyle, getDraggedx, getDraggedy, getDragImage, getDragRegionStatus, getDragSpeed, getDragTransparency, getEditingDelegate, getGridPosX, getGridPosY, getHeight, getInlineAllStyles, getInlineDisabledStyles, getInlinePressedStyles, getInlineSelectedStyles, getInlineStylesTheme, getInlineUnselectedStyles, getInnerHeight, getInnerPreferredH, getInnerPreferredW, getInnerWidth, getInnerX, getInnerY, getLabelForComponent, getName, getNativeOverlay, getNextFocusDown, getNextFocusLeft, getNextFocusRight, getNextFocusUp, getOuterHeight, getOuterPreferredH, getOuterPreferredW, getOuterWidth, getOuterX, getOuterY, getOwner, getParent, getPreferredH, getPreferredSize, getPreferredSizeStr, getPreferredTabIndex, getPreferredW, getPressedStyle, getSameHeight, getSameWidth, getScrollable, getScrollAnimationSpeed, getScrollDimension, getScrollOpacity, getScrollOpacityChangeSpeed, getScrollX, getScrollY, getSelectCommandText, getSelectedRect, getSelectedStyle, getSideGap, getStyle, getTabIndex, getTensileLength, getTextSelectionSupport, getTooltip, getUIID, getUIManager, getUnselectedStyle, getVisibleBounds, getVisibleBounds, getWidth, getX, getY, growShrink, handlesInput, hasFixedPreferredSize, hasFocus, hideNativeOverlay, initCustomStyle, initDisabledStyle, initLaf, initPressedStyle, initSelectedStyle, initUnselectedStyle, installDefaultPainter, isAlwaysTensile, isBlockLead, isCellRenderer, isChildOf, isDragActivated, isDragAndDropOperation, isDraggable, isDragRegion, isDropTarget, isEditable, isEditing, isEnabled, isFlatten, isFocusable, isGrabsPointerEvents, isHidden, isHidden, isHideInLandscape, isHideInPortrait, isIgnorePointerEvents, isInClippingRegion, isInitialized, isOpaque, isOwnedBy, isPinchBlocksDragAndDrop, isRippleEffect, isRTL, isScrollable, isScrollableX, isScrollableY, isScrollVisible, isSelectableInteraction, isSetCursorSupported, isSmoothScrolling, isSnapToGrid, isStickyDrag, isTactileTouch, isTactileTouch, isTensileDragEnabled, isTraversable, isVisible, keyPressed, keyRepeated, longKeyPress, longPointerPress, onScrollX, onScrollY, onSetFocusable, paintBackgrounds, paintBorder, paintBorderBackground, paintComponent, paintComponent, paintIntersectingComponentsAbove, paintLock, paintLockRelease, paintRippleOverlay, paintScrollbars, paintScrollbarX, paintScrollbarY, paintShadows, paramString, parsePreferredSize, pinch, pointerDragged, pointerHover, pointerHoverPressed, pointerHoverReleased, pointerPressed, pointerReleased, putClientProperty, refreshTheme, refreshTheme, refreshTheme, remove, removeDragFinishedListener, removeDragOverListener, removeDropListener, removeFocusListener, removeLongPressListener, removePointerDraggedListener, removePointerPressedListener, removePointerReleasedListener, removeScrollListener, removeStateChangeListener, repaint, repaint, requestFocus, respondsToPointerEvents, scrollRectToVisible, scrollRectToVisible, setAccessibilityText, setAlwaysTensile, setBlockLead, setBoundPropertyValue, setCellRenderer, setCloudBoundProperty, setCloudDestinationProperty, setComponentState, setCursor, setDefaultDragTransparency, setDirtyRegion, setDisabledStyle, setDraggable, setDragTransparency, setDropTarget, setEditingDelegate, setEnabled, setFlatten, setFocus, setFocusable, setGrabsPointerEvents, setHandlesInput, setHeight, setHidden, setHidden, setHideInLandscape, setHideInPortrait, setIgnorePointerEvents, setInitialized, setInlineAllStyles, setInlineDisabledStyles, setInlinePressedStyles, setInlineSelectedStyles, setInlineStylesTheme, setInlineUnselectedStyles, setIsScrollVisible, setLabelForComponent, setName, setNextFocusDown, setNextFocusLeft, setNextFocusRight, setNextFocusUp, setOpaque, setOwner, setPinchBlocksDragAndDrop, setPreferredH, setPreferredSize, setPreferredSizeStr, setPreferredTabIndex, setPreferredW, setPressedStyle, setRippleEffect, setRTL, setSameHeight, setSameSize, setSameWidth, setScrollAnimationSpeed, setScrollOpacityChangeSpeed, setScrollSize, setScrollVisible, setScrollX, setScrollY, setSelectCommandText, setSelectedStyle, setShouldCalcPreferredSize, setSize, setSmoothScrolling, setSnapToGrid, setTabIndex, setTactileTouch, setTensileDragEnabled, setTensileLength, setTooltip, setTraversable, setUIID, setUIID, setUIIDFinal, setUnselectedStyle, setVisible, setWidth, setX, setY, shouldBlockSideSwipeLeft, shouldBlockSideSwipeRight, shouldRenderComponentSelection, showNativeOverlay, startEditingAsync, stopEditing, stripMarginAndPadding, styleChanged, toImage, toString, unbindProperty, updateNativeOverlay, visibleBoundsContains

Modifier and Type	Method	Description
void	addDragFinishedListener(ActionListener l)	Adds a listener to the dragFinished event
void	addDragOverListener(ActionListener l)	Broadcasts an event when dragging over a component
void	addDropListener(ActionListener l)	Binds an action listener to drop events which are invoked when this component is dropped on a target
void	addFocusListener(FocusListener l)	Registers interest in receiving callbacks for focus gained events, a focus event is invoked when the component accepts the focus.
void	addLongPressListener(ActionListener l)	Adds a listener to the pointer event
void	addPointerDraggedListener(ActionListener l)	Adds a listener to the pointer event
void	addPointerPressedListener(ActionListener l)	Adds a listener to the pointer event
void	addPointerReleasedListener(ActionListener l)	Adds a listener to the pointer event
void	addPullToRefresh(Runnable task)	This method adds a refresh task to the Component, the task will be executed if the user has pulled the scroll beyond a certain height.
void	addScrollListener(ScrollListener l)	Registers interest in receiving callbacks for scroll gained events, a scroll event is invoked when the component is scrolled.
void	addStateChangeListener(ActionListener<ComponentStateChangeEvent> l)	Adds a listener to be notified when the state of this component is changed to and from initialized.
void	announceForAccessibility(String text)	Manually announces text to native accessibility services, associating the announcement with this component when possible.
void	bindProperty(String prop, BindTarget target)	Binds the given property name to the given bind target
final boolean	blocksSideSwipe()	A component that might need side swipe such as the slider could block it from being used for some other purpose when on top of said component.
protected Dimension	calcScrollSize()	Method that can be overriden to represent the actual size of the component when it differs from the desireable size for the viewport
protected void	cancelRepaints()	remove this component from the painting queue
void	clearClientProperties()	Clears all client properties from this Component
boolean	contains(int x, int y)	Returns true if the given absolute coordinate is contained in the Component
boolean	containsOrOwns(int x, int y)	Checks to see if this component either contains the given point, or if it owns the component that contains the given point.
ComponentAnimation	createStyleAnimation(String destUIID, int duration)	Creates an animation that will transform the current component to the styling of the destination UIID when completed.
protected void	deinitializeCustomStyle(Style s)	Allows components to create a style of their own, this method cleans up state for the given style
protected void	dragEnter(Component dragged)	This callback method indicates that a component drag has just entered this component
protected void	dragExit(Component dragged)	This callback method provides an indication for a drop target that a drag operation is exiting the bounds of this component and it should clear all relevant state if such state exists.
protected boolean	draggingOver(Component dragged, int x, int y)	This method allows a component to indicate if it is a drop target for the given component at the given x/y location (in component coordiate space).
protected void	dragInitiated()	Invoked on the focus component to let it know that drag has started on the parent container for the case of a component that doesn't support scrolling
protected void	drawDraggedImage(Graphics g, Image img, int x, int y)	Draws the given image at x/y, this method can be overriden to draw additional information such as positive or negative drop indication
void	drop(Component dragged, int x, int y)	Performs a drop operation of the component at the given X/Y location in coordinate space, this method should be overriden by subclasses to perform all of the logic related to moving a component, by default this method does nothing and so dragging a component and dropping it has no effect
protected void	fireClicked()	When working in 3 softbutton mode "fire" key (center softbutton) is sent to this method in order to allow 3 button devices to work properly.
protected void	focusGained()	Callback allowing a developer to track when the component gains focus
protected void	focusLost()	Callback allowing a developer to track wheh the component loses focus
int	getAbsoluteX()	Returns the absolute X location based on the component hierarchy, this method calculates a location on the screen for the component rather than a relative location as returned by getX()
int	getAbsoluteY()	Returns the absolute Y location based on the component hierarchy, this method calculates a location on the screen for the component rather than a relative location as returned by getX()
String	getAccessibilityText()	Returns the text that describes this component to assistive technologies.
final Style	getAllStyles()	Returns a "meta style" that allows setting styles once to all the different Style objects, the getters for this style will be meaningless and will return 0 values.
AnimationManager	getAnimationManager()	Returns the animation manager of the parent form or null if this component isn't currently associated with a form
int	getBaseline(int width, int height)	The baseline for the component text according to which it should be aligned with other components for best visual look.
int	getBaselineResizeBehavior()	Returns a constant indicating how the baseline varies with the size of the component.
String[]	getBindablePropertyNames()	Returns the names of the properties within this component that can be bound for persistence, the order of these names mean that the first one will be the first bound
Class[]	getBindablePropertyTypes()	Returns the types of the properties that are bindable within this component
protected Border	getBorder()	Normally returns getStyle().getBorder() but some subclasses might use this to programmatically replace the border in runtime e.g.
int	getBottomGap()	Returns the gap to be left for the bottom scrollbar on the X axis.
Object	getBoundPropertyValue(String prop)	Allows the binding code to extract the value of the property
protected Rectangle	getBounds()	Returns the component bounds which is sometimes more convenient than invoking getX/Y/Width/Height.
Rectangle	getBounds(Rectangle rect)	Returns the bounds of this component in the provided Rectangle.
Object	getClientProperty(String key)	Client properties allow the association of meta-data with a component, this is useful for some applications that construct GUI's on the fly and need to track the connection between the UI and the data.
String	getCloudBoundProperty()	Indicates the property within this component that should be bound to the cloud object
String	getCloudDestinationProperty()	The destination property of the CloudObject
Form	getComponentForm()	Returns the Component Form or null if this Component is not added yet to a form
Object	getComponentState()	Some components may optionally generate a state which can then be restored using setCompnentState().
int	getCursor()	Gets the custom cursor for this component.
static byte	getDefaultDragTransparency()	Returns the default translucency used in the #getDragImage() method.
final Rectangle	getDirtyRegion()	gets the Component dirty region, this method is for internal use only and SHOULD NOT be invoked by user code.
Style	getDisabledStyle()	Returns the Component Style for the disabled state allowing us to manipulate the look of the component when its disabled
int	getDraggedx()	Gets the current dragged x values when the Component is being dragged
int	getDraggedy()	Gets the current dragged y values when the Component is being dragged
protected Image	getDragImage()	This method returns an image representing the dragged component, it can be overriden by subclasses to customize the look of the image, the image will be overlaid on top of the form during a drag and drop operation
protected int	getDragRegionStatus(int x, int y)	Indicates if the section within the X/Y area is a "drag region" where we expect people to drag or press in which case we can instantly start dragging making perceived performance faster.
protected float	getDragSpeed(boolean vertical)	This method returns the dragging speed based on the latest dragged events
byte	getDragTransparency()	Returns the translucency used in the #getDragImage() method.
Editable	getEditingDelegate()	Gets the delegate that handles the editing of this component.
protected int	getGridPosX()	This method should be implemented correctly by subclasses to make snap to grid functionality work as expected.
protected int	getGridPosY()	This method should be implemented correctly by subclasses to make snap to grid functionality work as expected.
int	getHeight()	Returns the component height
String	getInlineAllStyles()	Gets inline styles that are to be applied to all states of this component.
String	getInlineDisabledStyles()	Gets inline styles that are to be applied to the disabled state of this component.
String	getInlinePressedStyles()	Gets inline styles that are to be applied to the pressed state of this component.
String	getInlineSelectedStyles()	Gets inline styles that are to be applied to the selected state of this component.
Resources	getInlineStylesTheme()	Gets the theme that is used by inline styles to reference images.
String	getInlineUnselectedStyles()	Gets inline styles that are to be applied to the unselected state of this component.
int	getInnerHeight()	Gets the inner height of this component.
int	getInnerPreferredH()	Gets the preferred height removing vertical padding.
int	getInnerPreferredW()	Gets the preferred width removing horizontal padding.
int	getInnerWidth()	Gets the inner width of this component.
int	getInnerX()	Gets x-coordinate of the inner bounds of this component.
int	getInnerY()	Gets the inner y-coordinate of the inner bounds of this component.
Label	getLabelForComponent()	Allows us to indicate the label associated with this component thus providing visual feedback related for this component e.g.
String	getName()	A component name allows us to easily identify the component within a dynamic UI.
Object	getNativeOverlay()	Gets the native overlay for this component.
Component	getNextFocusDown()	Allows us to determine which component will receive focus next when traversing with the down key
Component	getNextFocusLeft()	Allows us to determine which component will receive focus next when traversing with the left key.
Component	getNextFocusRight()	Allows us to determine which component will receive focus next when traversing with the right key
Component	getNextFocusUp()	Allows us to determine which component will receive focus next when traversing with the up key.
int	getOuterHeight()	Gets the outer height of this component.
int	getOuterPreferredH()	Gets the preferred height including the vertical margins.
int	getOuterPreferredW()	Gets the preferred width including horizontal margins.
int	getOuterWidth()	Gets the outer width of this component.
int	getOuterX()	Gets the x-coordinate of the outer bounds of this component.
int	getOuterY()	Gets the Y-coordinate of the outer bounds of this component.
Component	getOwner()	Gets the "owner" of this component as set by #setOwner(com.codename1.ui.Component).
Container	getParent()	Returns the container in which this component is contained
int	getPreferredH()	Helper method to retrieve the preferred height of the component.
Dimension	getPreferredSize()	Returns the Component Preferred Size, there is no guarantee the Component will be sized at its Preferred Size.
String	getPreferredSizeStr()	Returns the preferred size string that can be used to specify the preferred size of the component using pixels or millimetres.
int	getPreferredTabIndex()	Gets the preferred tab index of this component.
int	getPreferredW()	Helper method to retrieve the preferred width of the component.
Style	getPressedStyle()	Returns the Component Style for the pressed state allowing us to manipulate the look of the component when it is pressed
Component[]	getSameHeight()	Returns the array of components that have an equal height
Component[]	getSameWidth()	Returns the array of components that have an equal width
Component	getScrollable()	Returns the scrollable parent of this component
int	getScrollAnimationSpeed()	Scroll animation speed in milliseconds allowing a developer to slow down or accelerate the smooth animation mode
Dimension	getScrollDimension()	Returns the Components dimension in scrolling, this is very similar to the preferred size aspect only it represents actual scrolling limits.
int	getScrollOpacity()	This method is used internally by the look and feel to implement the fading scrollbar behavior.
int	getScrollOpacityChangeSpeed()	Indicates the decrement units for the scroll opacity
int	getScrollX()	Indicates the X position of the scrolling, this number is relative to the component position and so a position of 0 would indicate the x position of the component.
int	getScrollY()	Indicates the Y position of the scrolling, this number is relative to the component position and so a position of 0 would indicate the y position of the component.
String	getSelectCommandText()	Allows determining the text for the select command used in the 3rd softbutton mode.
Rectangle	getSelectedRect()	Returns the component bounds with absolute screen coordinates, for components that include an internal selection behavior and are not containers (currently only List) this method allows returning the position of the selection itself which is useful for things such as the popup dialog and similar UI's that need to reference the position of the selection externally
Style	getSelectedStyle()	Returns the Component Style for the selected state allowing us to manipulate the look of the component when it owns focus
int	getSideGap()	Returns the gap to be left for the side scrollbar on the Y axis.
Style	getStyle()	Returns the current Component Style allowing code to draw the current component, you should normally use getUnselected/Pressed/DisabledStyle() and not this method since it will return different values based on component state.
int	getTabIndex()	Gets the tab index of the component.
int	getTensileLength()	Recommended length for the tensile, -1 for default
TextSelection.TextSelectionSupport	getTextSelectionSupport()	Returns text selection support object for this component.
String	getTooltip()	Returns
final String	getUIID()	Unique identifier for a component.
UIManager	getUIManager()	This method should be used by the Component to retrieve the correct UIManager to work with
final Style	getUnselectedStyle()	Returns the Component Style for the unselected mode allowing us to manipulate the look of the component
protected Rectangle	getVisibleBounds()	Returns the component bounds for scrolling which might differ from the getBounds for large components e.g.
Rectangle	getVisibleBounds(Rectangle rect)	Returns the component bounds for scrolling which might differ from the getBounds for large components into the provided rectangle.
int	getWidth()	Returns the component width
int	getX()	Returns the current component x location relatively to its parent container
int	getY()	Returns the component y location relatively to its parent container
void	growShrink(int duration)	Grows or shrinks this component to its new preferred size, this method essentially takes a component whose preferred size has changed and creates a "growing" effect that lasts for the duration.
boolean	handlesInput()	Prevents key events from being grabbed for focus traversal.
boolean	hasFixedPreferredSize()	Checks if this component has a fixed preferred size either via an explicit call to #setPreferredH(int) and #setPreferredW(int), or via a preferred size style string.
boolean	hasFocus()	Returns true if the component has focus
protected void	hideNativeOverlay()	Hides the native overlay for this component.
protected void	initCustomStyle(Style s)	Allows components to create a style of their own, this method binds the listener to the style and installs a bg painter
protected void	initDisabledStyle(Style disabledStyle)	Can be overridden by subclasses to perform initialization when the disabled style is set to a new value.
protected void	initLaf(UIManager uim)	This method initializes the Component defaults constants
protected void	initPressedStyle(Style pressedStyle)	Can be overridden by subclasses to perform initialization when the pressed style is set to a new value.
protected void	initSelectedStyle(Style selectedStyle)	Can be overridden by subclasses to perform initialization when the selected style is set to a new value.
protected void	initUnselectedStyle(Style unselectedStyle)	Can be overridden by subclasses to perform initialization when the unselected style is set to a new value.
protected void	installDefaultPainter(Style s)	Allows subclasses to create their own custom style types and install the background painter into them
boolean	isAlwaysTensile()	Enable the tensile drag to work even when a component doesn't have a scroll showable (scrollable flag still needs to be set to true)
boolean	isBlockLead()	Prevent a lead component hierarchy from this specific component, this allows a component within that hierarchy to still act as a standalone component
boolean	isCellRenderer()	Used as an optimization to mark that this component is currently being used as a cell renderer
boolean	isChildOf(Container cnt)	Searches the hierarchy of the component recursively to see if the given Container is one of the parents of this component
protected boolean	isDragActivated()	Indicates whether we are in the middle of a drag operation, this method allows developers overriding the pointer released events to know when this is a drag operation.
protected boolean	isDragAndDropOperation(int x, int y)	This method allows a developer to define only a specific portion of a component as draggable by default it returns true if the component is defined as "draggable"
boolean	isDraggable()	Indicates whether this component can be dragged in a drag and drop operation rather than scroll the parent
protected boolean	isDragRegion(int x, int y)	Indicates if the section within the X/Y area is a "drag region" where we expect people to drag and never actually "press" in which case we can instantly start dragging making perceived performance faster.
boolean	isDropTarget()	Indicates whether this component can receive dropped components into it, notice that when dropping on a component or container the parents will be checked recursively to find a valid drop target
boolean	isEditable()	Checks to see if the component is editable.
boolean	isEditing()	Checks if the component is currently being edited.
boolean	isEnabled()	Indicates whether component is enabled or disabled thus allowing us to prevent a component from receiving input events and indicate so visually
boolean	isFlatten()	Makes the component effectively opaque by blending the backgrounds into an image in memory so the layer of underlying components is only drawn once when this component is repainted.
boolean	isFocusable()	Returns true if this component can receive focus and is enabled
boolean	isGrabsPointerEvents()	This property is useful for blocking in z-order touch events, sometimes we might want to grab touch events in a specific component without making it focusable.
boolean	isHidden()	Returns true if the component was explicitly hidden by the user.
boolean	isHidden(boolean checkParent)	Checks if the component is hidden.
boolean	isHideInLandscape()	Indicates that this component and all its children should be hidden when the device is switched to landscape mode
boolean	isHideInPortrait()	Indicates that this component and all its children should be hidden when the device is switched to portrait mode
boolean	isIgnorePointerEvents()	Returns
protected boolean	isInClippingRegion(Graphics g)
protected boolean	isInitialized()	Indicates if the component is in the initialized state, a component is initialized when its initComponent() method was invoked.
boolean	isOpaque()	Checks whether the component's background should be painted.
boolean	isOwnedBy(Component cmp)	Checks to see if this component is owned by the given other component.
boolean	isPinchBlocksDragAndDrop()	returns true if pinch will block drag and drop
boolean	isRippleEffect()	Indicates whether the component displays the material design ripple effect
final boolean	isRTL()	Is the component a bidi RTL component
protected boolean	isScrollable()	Indicates whether the component should/could scroll by default a component is not scrollable.
boolean	isScrollableX()	Indicates whether the component should/could scroll on the X axis
boolean	isScrollableY()	Indicates whether the component should/could scroll on the Y axis
boolean	isScrollVisible()	Indicate whether this component scroll is visible
protected boolean	isSelectableInteraction()	This method allows a component to indicate that it is interested in an "implicit" select command to appear in the "fire" button when 3 softbuttons are defined in a device.
static boolean	isSetCursorSupported()	Checks to see if this platform supports cursors.
boolean	isSmoothScrolling()	Indicates that scrolling through the component should work as an animation
boolean	isSnapToGrid()	Indicates whether scrolling this component should jump to a specific location in a grid
protected boolean	isStickyDrag()	Returns true if the component is interested in receiving drag/pointer release events even after the gesture exceeded its boundaries.
boolean	isTactileTouch()	Indicates whether the component should "trigger" tactile touch when pressed by the user in a touch screen UI.
protected boolean	isTactileTouch(int x, int y)	Elaborate components might not provide tactile feedback for all their areas (e.g. Lists) this method defaults to returning the value of isTactileTouch
boolean	isTensileDragEnabled()	Indicates whether tensile drag (dragging beyond the boundry of the component and snapping back) is enabled for this component.
final boolean	isTraversable()	Checks if this component should be traversable using the keyboard using tab, next, previous keys.
boolean	isVisible()	Returns whether the component is visible or not
void	keyPressed(int keyCode)	If this Component is focused, the key pressed event will call this method
void	keyRepeated(int keyCode)	If this Component is focused, the key repeat event will call this method.
protected void	longKeyPress(int keyCode)	If this Component is focused this method is invoked when the user presses and holds the key
void	longPointerPress(int x, int y)	If this Component is focused this method is invoked when the user presses and holds the pointer on the Component
protected void	onScrollX(int scrollX)	This method can be overriden to receive scroll events, unlike overriding setScrollX it will receive all calls for scrolling.
protected void	onScrollY(int scrollY)	This method can be overriden to receive scroll events, unlike overriding setScrollY it will receive all calls for scrolling.
protected void	onSetFocusable(boolean focusable)	Since setFocusable is final this callback is invoked when focusable changes.
void	paintBackgrounds(Graphics g)	This method paints all the parents Components Background.
protected void	paintBorder(Graphics g)	Draws the component border if such a border exists.
protected void	paintBorderBackground(Graphics g)	Draws the component border background if such a border exists.
final void	paintComponent(Graphics g)	Paints this component as a root by going to all the parent components and setting the absolute translation based on coordinates and scroll status.
final void	paintComponent(Graphics g, boolean background)	Paints this component as a root by going to all the parent components and setting the absolute translation based on coordinates and scroll status.
void	paintIntersectingComponentsAbove(Graphics g)	Paints intersecting components that appear above this component.
Image	paintLock(boolean hardLock)	This method locks the component so it will always paint the given image instead of running through its paint logic.
void	paintLockRelease()	Releases the paint lock image to allow paint to work as usual, see paintLock(boolean) for details
void	paintRippleOverlay(Graphics g, int x, int y, int position)	Invoked to draw the ripple effect overlay in Android where the finger of the user causes a growing circular overlay over time.
protected void	paintScrollbars(Graphics g)	Paints the UI for the scrollbars on the component, this will be invoked only for scrollable components.
protected void	paintScrollbarX(Graphics g)	Paints the UI for the scrollbar on the X axis, this method allows component subclasses to customize the look of a scrollbar
protected void	paintScrollbarY(Graphics g)	Paints the UI for the scrollbar on the Y axis, this method allows component subclasses to customize the look of a scrollbar
void	paintShadows(Graphics g, int relativeX, int relativeY)	Paints the drop-shadow projections for this component based on its elevation value.
protected String	paramString()	Returns a string representing the state of this component.
static Dimension	parsePreferredSize(String preferredSize, Dimension baseSize)	Parses the preferred size given as a string
protected boolean	pinch(int[] x, int[] y)	Invoked by subclasses interested in handling pinch to do their own actions based on the position of the two fingers, if true is returned other drag events will not be broadcast
void	pointerDragged(int[] x, int[] y)	If this Component is focused, the pointer dragged event will call this method
void	pointerHover(int[] x, int[] y)	Invoked for devices where the pointer can hover without actually clicking the display.
void	pointerHoverPressed(int[] x, int[] y)	Invoked for devices where the pointer can hover without actually clicking the display.
void	pointerHoverReleased(int[] x, int[] y)	Invoked for devices where the pointer can hover without actually clicking the display.
void	pointerPressed(int[] x, int[] y)	If this Component is focused, the pointer pressed event will call this method
void	pointerReleased(int[] x, int[] y)	If this Component is focused, the pointer released event will call this method
void	putClientProperty(String key, Object value)	Client properties allow the association of meta-data with a component, this is useful for some applications that construct GUI's on the fly and need to track the connection between the UI and the data.
void	refreshTheme()	Makes sure the component is up to date with the current theme, ONLY INVOKE THIS METHOD IF YOU CHANGED THE THEME!
void	refreshTheme(boolean merge)	Makes sure the component is up to date with the current theme, ONLY INVOKE THIS METHOD IF YOU CHANGED THE THEME!
protected void	refreshTheme(String id, boolean merge)	Makes sure the component is up to date with the given UIID
void	remove()	This method will remove the Component from its parent.
void	removeDragFinishedListener(ActionListener l)	Removes the listener from the drag finished event
void	removeDragOverListener(ActionListener l)	Removes an action listener to drag over events
void	removeDropListener(ActionListener l)	Removes an action listener to drop events which are invoked when this component is dropped on a target
void	removeFocusListener(FocusListener l)	Deregisters interest in receiving callbacks for focus gained events
void	removeLongPressListener(ActionListener l)	Removes the listener from the pointer event
void	removePointerDraggedListener(ActionListener l)	Removes the listener from the pointer event
void	removePointerPressedListener(ActionListener l)	Removes the listener from the pointer event
void	removePointerReleasedListener(ActionListener l)	Removes the listener from the pointer event
void	removeScrollListener(ScrollListener l)	Deregisters interest in receiving callbacks for scroll gained events
void	removeStateChangeListener(ActionListener<ComponentStateChangeEvent> l)	Removes a listener from being notified when the state of this component is changed to and from initialized.
void	repaint()	Repaint this Component, the repaint call causes a callback of the paint method on the event dispatch thread.
void	repaint(int x, int y, int w, int h)	Repaints a specific region within the component
void	requestFocus()	Changes the current component to the focused component, will work only for a component that belongs to a parent form.
boolean	respondsToPointerEvents()	Checks if the component responds to pointer events.
void	scrollRectToVisible(int x, int y, int width, int height, Component coordinateSpace)	Makes sure the component is visible in the scroll if this container is scrollable
protected void	scrollRectToVisible(Rectangle rect, Component coordinateSpace)	Makes sure the component is visible in the scroll if this container is scrollable
void	setAccessibilityText(String text)	Sets the text that describes this component to assistive technologies.
void	setAlwaysTensile(boolean alwaysTensile)	Enable the tensile drag to work even when a component doesn't have a scroll showable (scrollable flag still needs to be set to true)
void	setBlockLead(boolean blockLead)	Prevent a lead component hierarchy from this specific component, this allows a component within that hierarchy to still act as a standalone component
void	setBoundPropertyValue(String prop, Object value)	Sets the value of a bound property within this component, notice that this method MUST NOT fire the property change event when invoked to prevent recursion!
void	setCellRenderer(boolean cellRenderer)	Used as an optimization to mark that this component is currently being used as a cell renderer
void	setCloudBoundProperty(String cloudBoundProperty)	Indicates the property within this component that should be bound to the cloud object
void	setCloudDestinationProperty(String cloudDestinationProperty)	The destination property of the CloudObject
void	setComponentState(Object state)	If getComponentState returned a value the setter can update the value and restore the prior state.
void	setCursor(int cursor)	Sets a custom mouse cursor for this component if the platform supports mouse cursors, notice that this isn't applicable for touch devices.
static void	setDefaultDragTransparency(byte defaultDragTransparency)	Sets the default translucency of the #getDragImage() method.
final void	setDirtyRegion(Rectangle dirty)	sets the Component dirty region, this method is for internal use only and SHOULD NOT be invoked by user code.
void	setDisabledStyle(Style style)	Changes the Component disalbed Style by replacing the Component Style with the given Style
void	setDraggable(boolean draggable)	Indicates whether this component can be dragged in a drag and drop operation rather than scroll the parent
void	setDragTransparency(byte dragTransparency)	Sets the translucency of the #getDragImage() method.
void	setDropTarget(boolean dropTarget)	Indicates whether this component can receive dropped components into it, notice that when dropping on a component or container the parents will be checked recursively to find a valid drop target
void	setEditingDelegate(Editable editable)	Sets the editing delegate for this component.
void	setEnabled(boolean enabled)	Indicates whether component is enabled or disabled thus allowing us to prevent a component from receiving input events and indicate so visually
void	setFlatten(boolean flatten)	Makes the component effectively opaque by blending the backgrounds into an image in memory so the layer of underlying components is only drawn once when this component is repainted.
void	setFocus(boolean focused)	This flag doesn't really give focus, its a state that determines what colors from the Style should be used when painting the component.
final void	setFocusable(boolean focusable)	A simple setter to determine if this Component can get focused
void	setGrabsPointerEvents(boolean grabsPointerEvents)	This property is useful for blocking in z-order touch events, sometimes we might want to grab touch events in a specific component without making it focusable.
void	setHandlesInput(boolean handlesInput)	Prevents key events from being grabbed for focus traversal.
void	setHeight(int height)	Sets the Component height, this method is exposed for the purpose of external layout managers and should not be invoked directly.
void	setHidden(boolean b)	Makes the components preferred size equal 0 when hidden and restores it to the default size when not.
void	setHidden(boolean b, boolean changeMargin)	Makes the components preferred size equal 0 when hidden and restores it to the default size when not.
void	setHideInLandscape(boolean hideInLandscape)	Indicates that this component and all its children should be hidden when the device is switched to landscape mode
void	setHideInPortrait(boolean hideInPortrait)	Indicates that this component and all its children should be hidden when the device is switched to portrait mode
void	setIgnorePointerEvents(boolean ignorePointerEvents)	Parameters
protected void	setInitialized(boolean initialized)	Indicates if the component is in the initialized state, a component is initialized when its initComponent() method was invoked.
void	setInlineAllStyles(String styles)	Registers inline styles that should be applied to all states of the component.
void	setInlineDisabledStyles(String styles)	Registers inline styles that should be applied to the disabled state of the component.
void	setInlinePressedStyles(String styles)	Registers inline styles that should be applied to the pressed state of the component.
void	setInlineSelectedStyles(String styles)	Registers inline styles that should be applied to the selected state of the component.
void	setInlineStylesTheme(Resources inlineStylesTheme)	Sets the theme that is used by inline styles to reference images.
void	setInlineUnselectedStyles(String styles)	Registers inline styles that should be applied to the unselected state of the component.
void	setIsScrollVisible(boolean isScrollVisible)	Set whether this component scroll is visible
void	setLabelForComponent(Label componentLabel)	Allows us to indicate the label associated with this component thus providing visual feedback related for this component e.g.
void	setName(String name)	A component name allows us to easily identify the component within a dynamic UI.
void	setNextFocusDown(Component nextFocusDown)	Allows us to determine which component will receive focus next when traversing with the down key
void	setNextFocusLeft(Component nextFocusLeft)	Allows us to determine which component will receive focus next when traversing with the left key, this method doesn't affect the general focus behavior.
void	setNextFocusRight(Component nextFocusRight)	Allows us to determine which component will receive focus next when traversing with the right key
void	setNextFocusUp(Component nextFocusUp)	Allows us to determine which component will receive focus next when traversing with the up key, this method doesn't affect the general focus behavior.
final void	setOpaque(boolean opaque)	Sets whether or not to paint the component background.
void	setOwner(Component owner)	Sets the owner of this component to the specified component.
void	setPinchBlocksDragAndDrop(boolean block)	If a component supports pinch as well as drag and drop the two may conflict (if one finger is placed a bit before the other, the drag timer will be initiated and may trigger drag even if the second finger has been placed before).
void	setPreferredH(int preferredH)	Helper method to set the preferred height of the component.
void	setPreferredSize(Dimension d)	Sets the Component Preferred Size, there is no guarantee the Component will be sized at its Preferred Size.
void	setPreferredSizeStr(String value)	Parameters
void	setPreferredTabIndex(int index)	Sets the preferred tab index of the component.
void	setPreferredW(int preferredW)	Helper method to set the preferred width of the component.
void	setPressedStyle(Style style)	Sets the Component Style for the pressed state allowing us to manipulate the look of the component when it is pressed
void	setRippleEffect(boolean rippleEffect)	Indicates whether the component displays the material design ripple effect
void	setRTL(boolean rtl)	Is the component a bidi RTL component
static void	setSameHeight(Component... c)	Places all of these components in the same height group, to remove a component from the group invoke this method with that component only.
static void	setSameSize(Component... c)	This is identical to invoking #sameWidth followed by #sameHeight
static void	setSameWidth(Component... c)	Places all of these components in the same width group, to remove a component from the group invoke this method with that component only.
void	setScrollAnimationSpeed(int animationSpeed)	Scroll animation speed in milliseconds allowing a developer to slow down or accelerate the smooth animation mode
void	setScrollOpacityChangeSpeed(int scrollOpacityChangeSpeed)	Indicates the decrement units for the scroll opacity
void	setScrollSize(Dimension d)	Set the size for the scroll area
void	setScrollVisible(boolean isScrollVisible)	Set whether this component scroll is visible
protected void	setScrollX(int scrollX)	Indicates the X position of the scrolling, this number is relative to the component position and so a position of 0 would indicate the x position of the component.
protected void	setScrollY(int scrollY)	Indicates the Y position of the scrolling, this number is relative to the component position and so a position of 0 would indicate the y position of the component.
void	setSelectCommandText(String selectText)	Allows determining the text for the select command used in the 3rd softbutton mode.
void	setSelectedStyle(Style style)	Changes the Component selected Style by replacing the Component Style with the given Style
void	setShouldCalcPreferredSize(boolean shouldCalcPreferredSize)	Indicates the values within the component have changed and preferred size should be recalculated
void	setSize(Dimension d)	Sets the Component size, this method is exposed for the purpose of external layout managers and should not be invoked directly.
void	setSmoothScrolling(boolean smoothScrolling)	Indicates that scrolling through the component should work as an animation
void	setSnapToGrid(boolean snapToGrid)	Indicates whether scrolling this component should jump to a specific location in a grid
void	setTabIndex(int index)	Sets the tab index of the component.
void	setTactileTouch(boolean tactileTouch)	Indicates whether the component should "trigger" tactile touch when pressed by the user in a touch screen UI.
void	setTensileDragEnabled(boolean tensileDragEnabled)	Indicates whether tensile drag (dragging beyond the boundry of the component and snapping back) is enabled for this component.
void	setTensileLength(int tensileLength)	Recommended length for the tensile, -1 for default
void	setTooltip(String tooltip)	Parameters
final void	setTraversable(boolean traversable)	Sets whether this component is traversable using the keyboard using tab, next, previous keys.
void	setUIID(String id)	This method sets the Component the Unique identifier.
void	setUIID(String portraitUiid, String landscapeUiid)	This method sets the Component the Unique identifier.
protected final void	setUIIDFinal(String id)	This method is the implementation of setUIID and is defined as final to allow invocation from constructors.
void	setUnselectedStyle(Style style)	Changes the Component Style by replacing the Component Style with the given Style
void	setVisible(boolean visible)	Toggles visibility of the component
void	setWidth(int width)	Sets the Component width, this method is exposed for the purpose of external layout managers and should not be invoked directly.
void	setX(int x)	Sets the Component x location relative to the parent container, this method is exposed for the purpose of external layout managers and should not be invoked directly.
void	setY(int y)	Sets the Component y location relative to the parent container, this method is exposed for the purpose of external layout managers and should not be invoked directly.
protected boolean	shouldBlockSideSwipeLeft()	A component that might need side swipe such as the tabs could block it from being used for some other purpose when on top of said component.
protected boolean	shouldBlockSideSwipeRight()	A component that might need side swipe such as the tabs could block it from being used for some other purpose when on top of said component.
protected boolean	shouldRenderComponentSelection()	A component can indicate whether it is interested in rendering it's selection explicitly, this defaults to true in non-touch UI's and false in touch UI's except for the case where a user clicks the screen.
protected void	showNativeOverlay()	Creates the native overlay for this component.
void	startEditingAsync()	If the component #isEditable(), then this will start the editing process.
void	stopEditing(Runnable onFinish)	Stops the editing process.
Component	stripMarginAndPadding()	Convenience method that strips margin and padding from the component, and returns itself for chaining.
void	styleChanged(String propertyName, Style source)	Invoked to indicate a change in a propertyName of a Style
Image	toImage()	Returns the component as an image.
String	toString()	Overriden to return a useful value for debugging purposes
void	unbindProperty(String prop, BindTarget target)	Removes a bind target from the given property name
protected void	updateNativeOverlay()	Updates the native overlay for this component.
boolean	visibleBoundsContains(int x, int y)	Returns true if the given absolute coordinate is contained inside the visible bounds of the component.

Methods inherited from class Object

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

Modifier and Type	Method	Description
protected Object	clone()
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.
final void	wait()	Causes current thread to wait until another thread invokes the method or the method for this object.
final void	wait(long timeout)	Causes current thread to wait until either another thread invokes the method or the method for this object, or a specified amount of time has elapsed.
final void	wait(long timeout, int nanos)	Causes current thread to wait until another thread invokes the method or the method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.

Field Details

IMAGE_FIT

public static final int IMAGE_FIT

Indicates the initial position of the image in the viewer to FIT to the component size

See Also:

• Constant Field Values

IMAGE_FILL

public static final int IMAGE_FILL

Indicates the initial position of the image in the viewer to FILL the component size. Notice this type might drop edges of the images in order to stretch the image to the full size of the Component.

See Also:

• Constant Field Values

Constructor Details

ImageViewer

public ImageViewer()

Default constructor

ImageViewer

public ImageViewer(Image i)

Initializes the component with an image

Parameters

• i: image to show

Method Details

resetFocusable

protected void resetFocusable()

Restores the state of the focusable flag to its default state

Overrides:

resetFocusable in class Component

getPropertyNames

public String[] getPropertyNames()

A component may expose mutable property names for a UI designer to manipulate, this API is designed for usage internally by the GUI builder code

Returns

the property names allowing mutation

Overrides:

getPropertyNames in class Component

shouldBlockSideSwipe

protected boolean shouldBlockSideSwipe()

A component that might need side swipe such as the slider could block it from being used for some other purpose when on top of said component.

Overrides:

shouldBlockSideSwipe in class Component

getPropertyTypes

public Class[] getPropertyTypes()

Matches the property names method (see that method for further details).

Returns

the types of the properties

Overrides:

getPropertyTypes in class Component

getPropertyTypeNames

public String[] getPropertyTypeNames()

This method is here to workaround an XMLVM array type bug where property types aren't identified properly, it returns the names of the types using the following type names: String,int,double,long,byte,short,char,String[],String[][],byte[],Image,Image[],Object[],ListModel,ListCellRenderer

Returns

Array of type names

Overrides:

getPropertyTypeNames in class Component

getPropertyValue

public Object getPropertyValue(String name)

Returns the current value of the property name, this method is used by the GUI builder

Parameters

• name: the name of the property

Returns

the value of said property

Overrides:

getPropertyValue in class Component

setPropertyValue

public String setPropertyValue(String name,
 Object value)

Sets a new value to the given property, returns an error message if failed and null if successful. Notice that some builtin properties such as "$designMode" might be sent to components to indicate application state.

Parameters

• name: the name of the property

• value: new value for the property

Returns

error message or null

Overrides:

setPropertyValue in class Component

initComponent

public void initComponent()

Allows subclasses to bind functionality that relies on fully initialized and "ready for action" component state

Overrides:

initComponent in class Component

getImageX

public int getImageX()

Returns the x position of the image viewport which can be useful when it is being panned by the user

Returns

x position within the image for the top left corner

getImageY

public int getImageY()

Returns the y position of the image viewport which can be useful when it is being panned by the user

Returns

y position within the image for the top left corner

deinitialize

public void deinitialize()

Invoked to indicate that the component initialization is being reversed since the component was detached from the container hierarchy. This allows the component to deregister animators and cleanup after itself. This method is the opposite of the initComponent() method.

Overrides:

deinitialize in class Component

keyReleased

public void keyReleased(int key)

If this Component is focused, the key released event will call this method

Parameters

• keyCode: the key code value to indicate a physical key.

Overrides:

keyReleased in class Component

pointerPressed

public void pointerPressed(int x,
 int y)

If this Component is focused, the pointer pressed event will call this method

Parameters

• x: the pointer x coordinate

• y: the pointer y coordinate

Overrides:

pointerPressed in class Component

dragFinished

protected void dragFinished(int x,
 int y)

Description copied from class: Component

Callback indicating that the drag has finished either via drop or by releasing the component

Parameters

• x: the x location

• y: the y location

Overrides:

dragFinished in class Component

pointerReleased

public void pointerReleased(int x,
 int y)

If this Component is focused, the pointer released event will call this method

Parameters

• x: the pointer x coordinate

• y: the pointer y coordinate

Overrides:

pointerReleased in class Component

pinchReleased

protected void pinchReleased(int x,
 int y)

Description copied from class: Component

To be implemented by subclasses interested in being notified when a pinch zoom has ended (i.e the user has removed one of their fingers, but is still dragging).

Parameters

• x: The x-coordinate of the remaining finger in the drag. (Absolute)

• y: The y-coordinate of the remaining finger in the drag. (Absolute)

Since

7.0

Overrides:

pinchReleased in class Component

pointerDragged

public void pointerDragged(int x,
 int y)

If this Component is focused, the pointer dragged event will call this method

Parameters

• x: the pointer x coordinate

• y: the pointer y coordinate

Overrides:

pointerDragged in class Component

laidOut

protected void laidOut()

This is a callback method to inform the Component when it's been laidout on the parent Container

Overrides:

laidOut in class Component

pinch

protected boolean pinch(float scale)

Invoked by subclasses interested in handling pinch to zoom events, if true is returned other drag events will not be broadcast

Parameters

• scale: @param scale the scaling of the pinch operation a number larger than 1 means scaling up and smaller than 1 means scaling down. It is recommended that code would threshold the number (so a change between 1.0 and 1.02 shouldn't necessarily trigger zoom). Notice that this number is relevant to current zoom levels and unaware of them so you should also enforce limits of maximum/minimum zoom levels.

Returns

false by default

Overrides:

pinch in class Component

getCroppedImage

public Image getCroppedImage(int backgroundColor)

Gets the current image cropped using the current pan and zoom state. The cropped image dimensions will be the result of cropping the full-sized image with the current pan/zoom state. The aspect ratio will match the aspect ratio of the ImageViewer - not the source image itself.

Parameters

• backgroundColor: The background color, visible for letterboxing.

Returns

The cropped image.

Since

7.0

getCroppedImage

public Image getCroppedImage(int width,
 int height,
 int backgroundColor)

Gets the current image cropped using the current pan and zoom state.

Parameters

• width: The width of the cropped image. Use -1 to match aspect ratio of the ImageViewer component. Either height or width must be positive.

• height: The height of the cropped image. Use -1 to match aspect ratio of the ImageViewer component. Either height or width must be positive.

• backgroundColor: Background color to use for letterboxing.

Returns

Cropped image in specified dimensions.

Since

7.0

calcPreferredSize

protected Dimension calcPreferredSize()

Calculates the preferred size based on component content. This method is invoked lazily by getPreferred size.

Returns

the calculated preferred size based on component content

Overrides:

calcPreferredSize in class Component

animate

public boolean animate()

Allows the animation to reduce "repaint" calls when it returns false. It is called once for every frame. Frames are defined by the com.codename1.ui.Display class.

Returns

true if a repaint is desired or false if no repaint is necessary

Specified by:

animate in interface Animation

Overrides:

animate in class Component

isAllowScaleDown

public boolean isAllowScaleDown()

Allows the image to scale down when image initial position is set to fit this is off by default since the UX isn't great

Returns

the allowScaleDown

setAllowScaleDown

public void setAllowScaleDown(boolean allowScaleDown)

Allows the image to scale down when image initial position is set to fit this is off by default since the UX isn't great

Parameters

• allowScaleDown: the allowScaleDown to set

paint

public void paint(Graphics g)

This method paints the Component on the screen, it should be overriden by subclasses to perform custom drawing or invoke the UI API's to let the PLAF perform the rendering.

Parameters

• g: the component graphics

Specified by:

paint in interface Animation

Overrides:

paint in class Component

paintBackground

protected void paintBackground(Graphics g)

This method paints the Component background, it should be overriden by subclasses to perform custom background drawing.

Parameters

• g: the component graphics

Overrides:

paintBackground in class Component

getImage

public Image getImage()

Returns the currently showing image

Returns

the image

setImage

public final void setImage(Image image)

Sets the currently showing image

Parameters

• image: the image to set

setImageNoReposition

public void setImageNoReposition(Image image)

Sets the current image without any changes to the panning/scaling

Parameters

• image: new image instance

getImageList

public ListModel<Image> getImageList()

Returns the list model containing the images in the we can swipe through

Returns

the list model

setImageList

public void setImageList(ListModel<Image> model)

By providing this optional list of images you can allows swiping between multiple images

Parameters

• model: a list of images

setAnimateZoom

public void setAnimateZoom(boolean animateZoom)

Indicates if the zoom should bee animated. It's true by default

Parameters

• animateZoom: true if zoom is animated

isAnimatedZoom

public boolean isAnimatedZoom()

Indicates if the zoom should bee animated. It's true by default

Returns

true if zoom is animated

isNavigationArrowsVisible

public boolean isNavigationArrowsVisible()

Indicates if side navigation arrows should be painted for moving between images.

Returns

true if side navigation arrows are visible.

setNavigationArrowsVisible

public void setNavigationArrowsVisible(boolean navigationArrowsVisible)

Enables side navigation arrows (material font icons) for moving between images.

Parameters

• navigationArrowsVisible: true to show side navigation arrows.

isThumbnailsVisible

public boolean isThumbnailsVisible()

Indicates if thumbnails should be painted in a strip at the bottom for direct image selection.

Returns

true if the thumbnail strip is visible.

setThumbnailsVisible

public void setThumbnailsVisible(boolean thumbnailsVisible)

Enables a bottom thumbnail strip for direct image selection.

Parameters

• thumbnailsVisible: true to show thumbnails.

getThumbnailBarHeight

public float getThumbnailBarHeight()

Gets the thumbnail strip height in millimeters.

Returns

Height of the thumbnail strip in millimeters.

setThumbnailBarHeight

public void setThumbnailBarHeight(float thumbnailBarHeight)

Sets the thumbnail strip height in millimeters.

Parameters

• thumbnailBarHeight: Height of the thumbnail strip in millimeters.

getZoom

public float getZoom()

Manipulate the zoom level of the application

Returns

the zoom

setZoom

public void setZoom(float zoom)

Manipulate the zoom level of the application

Parameters

• zoom: the zoom to set

setZoom

public void setZoom(float zoom,
 float panPositionX,
 float panPositionY)

Manipulate the zoom level of the application

Parameters

• zoom: the zoom to set

• panPositionX: A float value between 0 and 1 to set the image x position

• panPositionY: A float value between 0 and 1 to set the image y position

getSwipePlaceholder

public Image getSwipePlaceholder()

This image is shown briefly during swiping while the full size image is loaded

Returns

the swipePlaceholder

setSwipePlaceholder

public void setSwipePlaceholder(Image swipePlaceholder)

This image is shown briefly during swiping while the full size image is loaded

Parameters

• swipePlaceholder: the swipePlaceholder to set

isEagerLock

public boolean isEagerLock()

Eager locking effectively locks the right/left images as well as the main image, as a result more heap is taken

Returns

the eagerLock

setEagerLock

public void setEagerLock(boolean eagerLock)

Eager locking effectively locks the right/left images as well as the main image, as a result more heap is taken

Parameters

• eagerLock: the eagerLock to set

isCycleLeft

public boolean isCycleLeft()

By default the ImageViewer cycles from the beginning to the end of the list when going to the left, setting this to false prevents this behaviour

Returns

true if it should cycle left from beginning

setCycleLeft

public void setCycleLeft(boolean cycleLeft)

By default the ImageViewer cycles from the beginning to the end of the list when going to the left, setting this to false prevents this behaviour

Parameters

• cycleLeft: the cycle left to set

isCycleRight

public boolean isCycleRight()

By default the ImageViewer cycles from the end to the beginning of the list when going to the right, setting this to false prevents this behaviour

Returns

true if it should cycle right from the end

setCycleRight

public void setCycleRight(boolean cycleRight)

By default the ImageViewer cycles from the end to the beginning of the list when going to the right, setting this to false prevents this behaviour

Parameters

• cycleRight: the cycle right to set

getSwipeThreshold

public float getSwipeThreshold()

The swipe threshold is a number between 0 and 1 that indicates the threshold after which the swiped image moves to the next image. Below that number the image will bounce back

Returns

the threshold

setSwipeThreshold

public void setSwipeThreshold(float swipeThreshold)

The swipe threshold is a number between 0 and 1 that indicates the threshold after which the swiped image moves to the next image. Below that number the image will bounce back

Parameters

• swipeThreshold: the swipeThreshold to set

setImageInitialPosition

public void setImageInitialPosition(int imageInitialPosition)

Sets the viewer initial image position to fill or to fit.

Parameters

• imageInitialPosition: values can be IMAGE_FILL or IMAGE_FIT