com.codename1.ui

Class PeerComponent

java.lang.Object

com.codename1.ui.Component

com.codename1.ui.PeerComponent

All Implemented Interfaces:

Animation, Editable, StyleListener

public class PeerComponent
extends Component

A peer component is essentially a "dummy" Codename One component used to calculate the position of the actual native platform specific component. The behavior of a peer component is very platform specific, it is meant for platforms where a native component can be integrated with a Codename One component. Codename One features such as glass pane, z-ordering, dialogs & menus might not work as expected in all situations where peer components are involved. E.g. a peer component might hide itself when a menu/dialog is shown and recreate itself when it is hidden/disposed.

Field Summary

Fields inherited from class com.codename1.ui.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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PeerComponent(Object nativePeer) This constructor is used by the platform implementation to create instances of this class use the static create method.

Method Summary

Modifier and Type	Method and 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.
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
static PeerComponent	create(Object nativePeer) Use this method to encapsulate a native UI object
protected void	deinitialize() Invoked to indicate that the component initialization is being reversed since the component was detached from the container hierarchy.
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 wheh the component gains focus
protected void	focusLost() Callback allowing a developer to track wheh the component loses focus
protected Image	generatePeerImage() The native implementation should implement this method to generate a native peer image representing the component
Object	getNativePeer() Returns the native peer instance
protected Image	getPeerImage() The peer image is drawn when the component doesn't exist or during transition a placeholder image can be placed in the beginning to show something while the peer is being created asynchronously.
boolean	handlesInput() Prevents key events from being grabbed for focus traversal.
protected void	initComponent() Allows subclasses to bind functionality that relies on fully initialized and "ready for action" component state
void	invalidate() Updates the size of the component from the native widget
void	keyPressed(int keyCode) If this Component is focused, the key pressed event will call this method
void	keyReleased(int keyCode) If this Component is focused, the key released event will call this method
void	keyRepeated(int keyCode) If this Component is focused, the key repeat event will call this method.
protected void	onPositionSizeChange() Callback useful for sublclasses that need to track the change in size/position of the component (notice that this might be invoked too many times for a single change)!
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.
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	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	pointerDragged(int[] x, int[] y) If this Component is focused, the pointer dragged event will call this method
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	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	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	pointerReleased(int x, int y) If this Component is focused, the pointer released event will call this method
protected void	setLightweightMode(boolean l) An optional callback for peers indicating that the peer is now rendered as part of a transition or some other state and is thus not truly visible.
protected void	setPeerImage(Image i) The peer image is drawn when the component doesn't exist or during transition a placeholder image can be placed in the beginning to show something while the peer is being created asynchronously.
protected boolean	shouldRenderPeerImage() Subclasses should return true here if the peer image should be rendered instead of the actual peer

Methods inherited from class com.codename1.ui.Component

addDragFinishedListener, addDragOverListener, addDropListener, addFocusListener, addLongPressListener, addPointerDraggedListener, addPointerPressedListener, addPointerReleasedListener, addPullToRefresh, addScrollListener, addStateChangeListener, bindProperty, blocksSideSwipe, cancelRepaints, clearClientProperties, contains, containsOrOwns, createStyleAnimation, deinitializeCustomStyle, dragEnter, dragExit, dragFinished, draggingOver, dragInitiated, drawDraggedImage, drop, getAbsoluteX, getAbsoluteY, 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, getPropertyNames, getPropertyTypeNames, getPropertyTypes, getPropertyValue, 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, 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, laidOut, longKeyPress, longPointerPress, onScrollX, onScrollY, paintBorderBackground, paintComponent, paintComponent, paintIntersectingComponentsAbove, paintLock, paintLockRelease, paintRippleOverlay, paintShadows, paramString, parsePreferredSize, pinch, pinch, pinchReleased, pointerHoverPressed, putClientProperty, refreshTheme, refreshTheme, refreshTheme, remove, removeDragFinishedListener, removeDragOverListener, removeDropListener, removeFocusListener, removeLongPressListener, removePointerDraggedListener, removePointerPressedListener, removePointerReleasedListener, removeScrollListener, removeStateChangeListener, repaint, repaint, requestFocus, resetFocusable, respondsToPointerEvents, scrollRectToVisible, scrollRectToVisible, 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, setPropertyValue, 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, setUnselectedStyle, setVisible, setWidth, setX, setY, shouldBlockSideSwipe, shouldBlockSideSwipeLeft, shouldBlockSideSwipeRight, shouldRenderComponentSelection, showNativeOverlay, startEditingAsync, stopEditing, stripMarginAndPadding, styleChanged, toImage, toString, unbindProperty, updateNativeOverlay, visibleBoundsContains

Methods inherited from class java.lang.Object

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

Constructor Detail

PeerComponent

protected PeerComponent(Object nativePeer)

This constructor is used by the platform implementation to create instances of this class use the static create method.

Parameters:

nativePeer - the native platform specific peer component.

Method Detail

getPeerImage

protected Image getPeerImage()

The peer image is drawn when the component doesn't exist or during transition a placeholder image can be placed in the beginning to show something while the peer is being created asynchronously. This image might be replaced by an internal image representing the actual content of the peer

Returns:

an image

generatePeerImage

protected Image generatePeerImage()

The native implementation should implement this method to generate a native peer image representing the component

Returns:

a screenshot of the component

setPeerImage

protected void setPeerImage(Image i)

The peer image is drawn when the component doesn't exist or during transition a placeholder image can be placed in the beginning to show something while the peer is being created asynchronously. This image might be replaced by an internal image representing the actual content of the peer

Parameters:

i - the peer image

shouldRenderPeerImage

protected boolean shouldRenderPeerImage()

Subclasses should return true here if the peer image should be rendered instead of the actual peer

Returns:

true to render the peer image

create

public static PeerComponent create(Object nativePeer)

Use this method to encapsulate a native UI object

Parameters:

nativePeer - the native platform specific peer component.

getNativePeer

public Object getNativePeer()

Returns the native peer instance

Returns:

the native peer

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 Display class.

Specified by:

animate in interface Animation

Overrides:

animate in class Component

Returns:

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

calcPreferredSize

protected Dimension calcPreferredSize()

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

Overrides:

calcPreferredSize in class Component

Returns:

the calculated preferred size based on component content

calcScrollSize

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

Overrides:

calcScrollSize in class Component

Returns:

scroll size, by default this is the same as the preferred size

deinitialize

protected 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

fireClicked

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. When overriding this method you should also override isSelectableInteraction to indicate that a command is placed appropriately on top of the fire key for 3 soft button phones.

Overrides:

fireClicked in class Component

focusGained

protected void focusGained()

Callback allowing a developer to track wheh the component gains focus

Overrides:

focusGained in class Component

focusLost

protected void focusLost()

Callback allowing a developer to track wheh the component loses focus

Overrides:

focusLost in class Component

handlesInput

public boolean handlesInput()

Prevents key events from being grabbed for focus traversal. E.g. a list component might use the arrow keys for internal navigation so it will switch this flag to true in order to prevent the focus manager from moving to the next component.

Overrides:

handlesInput in class Component

Returns:

true if key events are being used for focus traversal ; otherwise false

initComponent

protected void initComponent()

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

Overrides:

initComponent in class Component

keyPressed

public void keyPressed(int keyCode)

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

Overrides:

keyPressed in class Component

Parameters:

keyCode - the key code value to indicate a physical key.

keyReleased

public void keyReleased(int keyCode)

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

Overrides:

keyReleased in class Component

Parameters:

keyCode - the key code value to indicate a physical key.

keyRepeated

public void keyRepeated(int keyCode)

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

Overrides:

keyRepeated in class Component

Parameters:

keyCode - the key code value to indicate a physical key.

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.

Specified by:

paint in interface Animation

Overrides:

paint in class Component

Parameters:

g - the component graphics

paintBackground

protected void paintBackground(Graphics g)

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

Overrides:

paintBackground in class Component

Parameters:

g - the component graphics

paintBackgrounds

public void paintBackgrounds(Graphics g)

This method paints all the parents Components Background.

Overrides:

paintBackgrounds in class Component

Parameters:

g - the graphics object

paintBorder

protected void paintBorder(Graphics g)

Draws the component border if such a border exists. The border unlike the content of the component will not be affected by scrolling for a scrollable component.

Overrides:

paintBorder in class Component

Parameters:

g - graphics context on which the border is painted

paintScrollbarX

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

Overrides:

paintScrollbarX in class Component

Parameters:

g - the component graphics

paintScrollbarY

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

Overrides:

paintScrollbarY in class Component

Parameters:

g - the component graphics

paintScrollbars

protected void paintScrollbars(Graphics g)

Paints the UI for the scrollbars on the component, this will be invoked only for scrollable components. This method invokes the appropriate X/Y versions to do all the work.

Overrides:

paintScrollbars in class Component

Parameters:

g - the component graphics

pointerDragged

public void pointerDragged(int[] x,
                           int[] y)

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

Overrides:

pointerDragged in class Component

Parameters:

x - the pointer x coordinate

y - the pointer y coordinate

pointerDragged

public void pointerDragged(int x,
                           int y)

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

Overrides:

pointerDragged in class Component

Parameters:

x - the pointer x coordinate

y - the pointer y coordinate

pointerHover

public void pointerHover(int[] x,
                         int[] y)

Invoked for devices where the pointer can hover without actually clicking the display. This is true for PC mouse pointer as well as some devices such as the BB storm.

Overrides:

pointerHover in class Component

Parameters:

x - the pointer x coordinate

y - the pointer y coordinate

pointerHoverReleased

public void pointerHoverReleased(int[] x,
                                 int[] y)

Invoked for devices where the pointer can hover without actually clicking the display. This is true for PC mouse pointer as well as some devices such as the BB storm.

Overrides:

pointerHoverReleased in class Component

Parameters:

x - the pointer x coordinate

y - the pointer y coordinate

pointerPressed

public void pointerPressed(int[] x,
                           int[] y)

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

Overrides:

pointerPressed in class Component

Parameters:

x - the pointer x coordinate

y - the pointer y coordinate

pointerPressed

public void pointerPressed(int x,
                           int y)

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

Overrides:

pointerPressed in class Component

Parameters:

x - the pointer x coordinate

y - the pointer y coordinate

pointerReleased

public void pointerReleased(int[] x,
                            int[] y)

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

Overrides:

pointerReleased in class Component

Parameters:

x - the pointer x coordinate

y - the pointer y coordinate

pointerReleased

public void pointerReleased(int x,
                            int y)

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

Overrides:

pointerReleased in class Component

Parameters:

x - the pointer x coordinate

y - the pointer y coordinate

invalidate

public void invalidate()

Updates the size of the component from the native widget

onPositionSizeChange

protected void onPositionSizeChange()

Callback useful for sublclasses that need to track the change in size/position of the component (notice that this might be invoked too many times for a single change)!

setLightweightMode

protected void setLightweightMode(boolean l)

An optional callback for peers indicating that the peer is now rendered as part of a transition or some other state and is thus not truly visible. In this case the peer should either make itself invisible or render itself as an image instead of natively

Parameters:

l - true to enable lightweight mode, false to disable it