Class MultiList
- All Implemented Interfaces:
Animation, Editable, ActionSource, StyleListener
A list with a com.codename1.components.MultiButton renderer, notice that
we strongly discourage usage of lists.. This simplifies the process of
working with the list and its model as the renderer comes pre-configured for common use cases.
public void showForm() {
Form hi = new Form("MultiList", new BorderLayout());
int mm = Display.getInstance().convertToPixels(3);
EncodedImage placeholder = EncodedImage.createFromImage(Image.createImage(mm * 3, mm * 4, 0), false);
Image icon1 = URLImage.createToStorage(placeholder, "icon1", "http://www.georgerrmartin.com/wp-content/uploads/2013/03/GOTMTI2.jpg");
Image icon2 = URLImage.createToStorage(placeholder, "icon2", "http://www.georgerrmartin.com/wp-content/uploads/2012/08/clashofkings.jpg");
Image icon3 = URLImage.createToStorage(placeholder, "icon3", "http://www.georgerrmartin.com/wp-content/uploads/2013/03/stormswordsMTI.jpg");
Image icon4 = URLImage.createToStorage(placeholder, "icon4", "http://www.georgerrmartin.com/wp-content/uploads/2012/08/feastforcrows.jpg");
Image icon5 = URLImage.createToStorage(placeholder, "icon5", "http://georgerrmartin.com/gallery/art/dragons05.jpg");
ArrayList> data = new ArrayList<>();
data.add(createListEntry("A Game of Thrones", "1996", icon1));
data.add(createListEntry("A Clash Of Kings", "1998", icon2));
data.add(createListEntry("A Storm Of Swords", "2000", icon3));
data.add(createListEntry("A Feast For Crows", "2005", icon4));
data.add(createListEntry("A Dance With Dragons", "2011", icon5));
data.add(createListEntry("The Winds of Winter", "2016 (please, please, please)", placeholder));
data.add(createListEntry("A Dream of Spring", "Ugh", placeholder));
DefaultListModel> model = new DefaultListModel<>(data);
MultiList ml = new MultiList(model);
hi.add(BorderLayout.CENTER, ml);
hi.show();
}
private Map createListEntry(String name, String date, Image icon) {
Map entry = new HashMap<>();
entry.put("Line1", name);
entry.put("Line2", date);
entry.put("icon", icon);
return entry;
}
-
Field Summary
Fields inherited from class List
FIXED_CENTER, FIXED_LEAD, FIXED_NONE, FIXED_NONE_CYCLIC, FIXED_NONE_ONE_ELEMENT_MARGIN_FROM_EDGE, FIXED_TRAIL, HORIZONTAL, VERTICALModifier and TypeFieldDescriptionstatic final intIndicates the list selection is fixed into place at the center of the liststatic final intIndicates the list selection is fixed into place at the top of the list or at the left of the liststatic final intIndicates the list isn't fixed and that selection is movablestatic final intIndicates that the list is not fixed in place but cycles its elementsstatic final intIndicates the list selection will only reach the edge when there are no more elements in the list.static final intIndicates the list selection is fixed into place at the bottom of the list or at the right of the liststatic final intIndicates the list orientation is HORIZONTALstatic final intIndicates the list orientation is VERTICALFields 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_CURSORModifier and TypeFieldDescriptionstatic final intAlignment to the baseline constraintstatic final intBox-orientation constant used to specify the bottom of a box.static final intBaseline resize behavior constant used to properly align components.static final intBaseline resize behavior constant used to properly align components.static final intBaseline resize behavior constant used to properly align components.static final intBaseline resize behavior constant used to properly align components.static final intIndicates a Component center alignmentstatic final intThe crosshair cursor type.static final intThe default cursorstatic final intUsed by getDragRegionStatus to indicate immediate dragabilitystatic final intUsed by getDragRegionStatus to indicate immediate dragabilitystatic final intUsed by getDragRegionStatus to indicate immediate dragabilitystatic final intUsed by getDragRegionStatus to indicate likely dragabilitystatic final intUsed by getDragRegionStatus to indicate likely dragabilitystatic final intUsed by getDragRegionStatus to indicate likely dragabilitystatic final intUsed by getDragRegionStatus to indicate no dragabilitystatic final intUsed by getDragRegionStatus to indicate limited dragabilitystatic final intUsed by getDragRegionStatus to indicate limited dragabilitystatic final intUsed by getDragRegionStatus to indicate limited dragabilitystatic final intThe east-resize cursor type.static final intThe hand cursor type.static final intBox-orientation constant used to specify the left side of a box.static final intThe move cursor type.static final intThe north-resize cursor type.static final intThe north-east-resize cursor type.static final intThe north-west-resize cursor type.static final intBox-orientation constant used to specify the right side of a box.static final intThe south-resize cursor type.static final intThe south-east-resize cursor type.static final intThe south-west-resize cursor type.static final intThe text cursor type.static final intBox-orientation constant used to specify the top of a box.static final intThe west-resize cursor type.static final intThe wait cursor type. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected voidInvoked to indicate that the component initialization is being reversed since the component was detached from the container hierarchy.String[]A component may expose mutable property names for a UI designer to manipulate, this API is designed for usage internally by the GUI builder codeClass[]Matches the property names method (see that method for further details).getPropertyValue(String name) Returns the current value of the property name, this method is used by the GUI builderAllows developers to customize the properties of the selected multi-button in codeAllows developers to customize the properties of the unselected multi-button in codeprotected voidAllows subclasses to bind functionality that relies on fully initialized and "ready for action" component statesetPropertyValue(String name, Object value) Sets a new value to the given property, returns an error message if failed and null if successful.Methods inherited from class List
addActionListener, addItem, addSelectionListener, animate, calcPreferredSize, fireActionEvent, fireActionEvent, fireClicked, getActionListeners, getCurrentSelected, getDragRegionStatus, getFixedSelection, getGridPosX, getGridPosY, getHint, getHintIcon, getItemGap, getListeners, getListSizeCalculationSampleCount, getMaxElementHeight, getMinElementHeight, getModel, getOrientation, getRenderer, getRenderingPrototype, getSelectedIndex, getSelectedItem, getSelectedRect, getSideGap, getVisibleBounds, initLaf, isCommandList, isDefaultFireOnClick, isDefaultIgnoreFocusComponentWhenUnfocused, isIgnoreFocusComponentWhenUnfocused, isLongPointerPressActionEnabled, isMutableRendererBackgrounds, isNumericKeyActions, isScrollableX, isScrollableY, isSelectableInteraction, isTactileTouch, keyPressed, keyReleased, laidOut, listSelectionChanged, longPointerPress, modelChanged, paint, paramString, pointerDragged, pointerHover, pointerHoverReleased, pointerPressed, pointerReleased, refreshTheme, removeActionListener, removeSelectionListener, scrollRectToVisible, setCommandList, setDefaultFireOnClick, setDefaultIgnoreFocusComponentWhenUnfocused, setFireOnClick, setFixedSelection, setHandlesInput, setHint, setHint, setHintIcon, setIgnoreFocusComponentWhenUnfocused, setInputOnFocus, setItemGap, setListCellRenderer, setListSizeCalculationSampleCount, setLongPointerPressActionEnabled, setMaxElementHeight, setMinElementHeight, setModel, setMutableRendererBackgrounds, setNumericKeyActions, setOrientation, setPaintFocusBehindList, setRenderer, setRenderingPrototype, setScrollToSelected, setSelectedIndex, setSelectedIndex, setSelectedItem, setShouldCalcPreferredSize, shouldRenderSelection, sizeModifier and TypeMethodDescriptionvoidAllows binding a listener to user selection actionsvoidAllows adding an element to a list if the underlying model supports this, notice that it is an optional operation and if the model does not support it (default list model does) then this operation may failed.voidInvoked to indicate interest in future selection eventsbooleananimate()Allows the animation to reduce "repaint" calls when it returns false.protected DimensionCalculates the preferred size based on component content.protected voidFires an action event for the current event source.protected voidTriggers the event to the listenersprotected voidWhen working in 3 softbutton mode "fire" key (center softbutton) is sent to this method in order to allow 3 button devices to work properly.This method allows extracting the action listeners from the current listintReturns the visual selection during a drag operation, otherwise equivalent to model.getSelectedIndexprotected intgetDragRegionStatus(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.intIndicates whether selection is fixable to place in which case all the elements in the list move and selection stays in place.protected intThis method should be implemented correctly by subclasses to make snap to grid functionality work as expected.protected intThis method should be implemented correctly by subclasses to make snap to grid functionality work as expected.getHint()Returns the hint textReturns the hint iconintReturns the gap between itemsThis method allows extracting the action listeners from the current listintIndicates the number of elements the list should check to determine the element sizes.intMaximum number of elements shown in a list, this member is used to calculate the list preferred size.intMinimum number of elements shown in a list, this member is used to calculate the list preferred size.getModel()Returns the model underlying the listintReturns the list orientationfinal ListCellRendererReturns the renderer which is used to draw list elementsSee set rendering prototypeintReturns the current selected offset in the listReturns the current selected item in the list or null for no selectionReturns 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 externallyintReturns the gap to be left for the side scrollbar on the Y axis.protected RectangleReturns the component bounds for scrolling which might differ from the getBounds for large components e.g.protected voidThis method initializes the Component defaults constantsbooleanIndicates that the list should be treated as a list of commands, if the user "clicks" a command from the list its action performed method is invoked.static booleanDefault value for the fire on click behaviorstatic booleanIndicates whether the list should not paint the focus component if the list itself has no focus.booleanIndicates whether the list should not paint the focus component if the list itself has no focus.booleanEnable/disable list action on long pointer press eventbooleanIndicates that the background of a cell renderer might mutate between one entry and the next, it is recommended that this flag remains false for performance reasons.booleanIndicate whether pressing the number keys should trigger an actionbooleanIndicates whether the component should/could scroll on the X axisbooleanIndicates whether the component should/could scroll on the Y axisprotected booleanThis 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.protected booleanisTactileTouch(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 isTactileTouchvoidkeyPressed(int keyCode) If this Component is focused, the key pressed event will call this methodvoidkeyReleased(int keyCode) If this Component is focused, the key released event will call this methodprotected voidlaidOut()This is a callback method to inform the Component when it's been laidout on the parent Containerprotected voidlistSelectionChanged(int oldSelected, int newSelected) Callback to allow subclasses to react to a selection change in the modelvoidlongPointerPress(int x, int y) If this Component is focused this method is invoked when the user presses and holds the pointer on the Componentprotected voidmodelChanged(int status, int index) Callback to allow subclasses to react to a change in the modelvoidThis 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 StringReturns a string representing the state of this component.voidpointerDragged(int x, int y) If this Component is focused, the pointer dragged event will call this methodvoidpointerHover(int[] x, int[] y) Invoked for devices where the pointer can hover without actually clicking the display.voidpointerHoverReleased(int[] x, int[] y) Invoked for devices where the pointer can hover without actually clicking the display.voidpointerPressed(int x, int y) If this Component is focused, the pointer pressed event will call this methodvoidpointerReleased(int x, int y) If this Component is focused, the pointer released event will call this methodvoidrefreshTheme(boolean merge) Makes sure the component is up to date with the current theme, ONLY INVOKE THIS METHOD IF YOU CHANGED THE THEME!voidAllows binding a listener to user selection actionsvoidInvoked to indicate no further interest in future selection eventsvoidscrollRectToVisible(Rectangle rect) Makes sure the selected index is visible if it is not in the current view rect the list will scroll so it fits withinvoidsetCommandList(boolean commandList) Indicates that the list should be treated as a list of commands, if the user "clicks" a command from the list its action performed method is invoked.static voidsetDefaultFireOnClick(boolean aDefaultFireOnClick) Default value for the fire on click behaviorstatic voidsetDefaultIgnoreFocusComponentWhenUnfocused(boolean aDefaultIgnoreFocusComponentWhenUnfocused) Indicates whether the list should not paint the focus component if the list itself has no focus.voidsetFireOnClick(boolean fireOnClick) This method determines if the List fires the action event when the pointer was clicked on one of the items, or only if the item was the selected item By default the value is true, this setting is only relevant for none fixed ListsvoidsetFixedSelection(int fixedSelection) Indicates whether selection is fixable to place in which case all the elements in the list move and selection stays in place.voidsetHandlesInput(boolean b) Prevents key events from being grabbed for focus traversal.voidSets the TextArea hint text, the hint text is displayed on the TextArea When there is no text in the TextAreavoidSets the TextArea hint text and Icon, the hint text and icon are displayed on the TextArea when there is no text in the TextAreavoidsetHintIcon(Image icon) Sets the TextArea hint icon, the hint is displayed on the TextArea When there is no text in the TextAreavoidsetIgnoreFocusComponentWhenUnfocused(boolean ignoreFocusComponentWhenUnfocused) Indicates whether the list should not paint the focus component if the list itself has no focus.voidsetInputOnFocus(boolean inputOnFocus) A list can start handling input implicitly upon gaining focus, this can make for a more intuitive UI when no other focus elements exist or when their use case is infrequent.voidsetItemGap(int itemGap) Set the gap between itemsvoidsetListCellRenderer(ListCellRenderer renderer) Sets the renderer which is used to draw list elementsvoidsetListSizeCalculationSampleCount(int listSizeCalculationSampleCount) Indicates the number of elements the list should check to determine the element sizes.voidsetLongPointerPressActionEnabled(boolean longPointerPressAction) Enable/disable list action on long pointer press eventvoidsetMaxElementHeight(int maxElementHeight) Maximum number of elements shown in a list, this member is used to calculate the list preferred size.voidsetMinElementHeight(int minElementHeight) Minimum number of elements shown in a list, this member is used to calculate the list preferred size.voidReplaces/sets the model underlying the listvoidsetMutableRendererBackgrounds(boolean mutableRendererBackgrounds) Indicates that the background of a cell renderer might mutate between one entry and the next, it is recommended that this flag remains false for performance reasons.voidsetNumericKeyActions(boolean numericKeyActions) Indicate whether pressing the number keys should trigger an actionvoidsetOrientation(int orientation) Sets the list orientation HORIZONTAL or VERTICALvoidsetPaintFocusBehindList(boolean paintFocusBehindList) This method determines if the animated focus is drawn on top of the List or behind the List when moving.final voidsetRenderer(ListCellRenderer renderer) Sets the renderer which is used to draw list elementsvoidsetRenderingPrototype(Object renderingPrototype) The rendering prototype is optionally used in calculating the size of the List and is recommended for performance reasons.voidsetScrollToSelected(boolean scrollToSelected) This flag indicates to the List if the List should scroll to the selected element when it's been initialized.voidsetSelectedIndex(int index) Sets the current selected offset in the list, by default this implementation will scroll the list to the selection if the selection is outside of the screenvoidsetSelectedIndex(int index, boolean scrollToSelection) Sets the current selected offset in the listvoidsetSelectedItem(Object item) Sets the current selected item in the listvoidsetShouldCalcPreferredSize(boolean shouldCalcPreferredSize) Indicates the values within the component have changed and preferred size should be recalculatedprotected booleanAllows subclasses to override the selection rendering for the component, specifically the spinner in some themesintsize()Returns the number of elements in the list, shorthand for getModel().getSize()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, dragFinished, draggingOver, dragInitiated, drawDraggedImage, drop, 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, getDragSpeed, getDragTransparency, getEditingDelegate, 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, getPropertyTypeNames, getSameHeight, getSameWidth, getScrollable, getScrollAnimationSpeed, getScrollDimension, getScrollOpacity, getScrollOpacityChangeSpeed, getScrollX, getScrollY, getSelectCommandText, getSelectedStyle, getStyle, getTabIndex, getTensileLength, getTextSelectionSupport, getTooltip, getUIID, getUIManager, getUnselectedStyle, getVisibleBounds, getWidth, getX, getY, growShrink, handlesInput, hasFixedPreferredSize, hasFocus, hideNativeOverlay, initCustomStyle, initDisabledStyle, 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, isScrollVisible, isSetCursorSupported, isSmoothScrolling, isSnapToGrid, isStickyDrag, isTactileTouch, isTensileDragEnabled, isTraversable, isVisible, keyRepeated, longKeyPress, onScrollX, onScrollY, onSetFocusable, paintBackground, paintBackgrounds, paintBorder, paintBorderBackground, paintComponent, paintComponent, paintIntersectingComponentsAbove, paintLock, paintLockRelease, paintRippleOverlay, paintScrollbars, paintScrollbarX, paintScrollbarY, paintShadows, parsePreferredSize, pinch, pinch, pinchReleased, pointerDragged, pointerHoverPressed, pointerPressed, pointerReleased, putClientProperty, refreshTheme, refreshTheme, remove, removeDragFinishedListener, removeDragOverListener, removeDropListener, removeFocusListener, removeLongPressListener, removePointerDraggedListener, removePointerPressedListener, removePointerReleasedListener, removeScrollListener, removeStateChangeListener, repaint, repaint, requestFocus, resetFocusable, respondsToPointerEvents, scrollRectToVisible, scrollRectToVisible, setAccessibilityText, setAlwaysTensile, setBlockLead, setBoundPropertyValue, setCellRenderer, setCloudBoundProperty, setCloudDestinationProperty, setComponentState, setCursor, setDefaultDragTransparency, setDirtyRegion, setDisabledStyle, setDraggable, setDragTransparency, setDropTarget, setEditingDelegate, setEnabled, setFlatten, setFocus, setFocusable, setGrabsPointerEvents, 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, setSize, setSmoothScrolling, setSnapToGrid, setTabIndex, setTactileTouch, setTensileDragEnabled, setTensileLength, setTooltip, setTraversable, setUIID, setUIID, setUIIDFinal, setUnselectedStyle, setVisible, setWidth, setX, setY, shouldBlockSideSwipe, shouldBlockSideSwipeLeft, shouldBlockSideSwipeRight, shouldRenderComponentSelection, showNativeOverlay, startEditingAsync, stopEditing, stripMarginAndPadding, styleChanged, toImage, toString, unbindProperty, updateNativeOverlay, visibleBoundsContainsModifier and TypeMethodDescriptionvoidAdds a listener to the dragFinished eventvoidBroadcasts an event when dragging over a componentvoidBinds an action listener to drop events which are invoked when this component is dropped on a targetvoidRegisters interest in receiving callbacks for focus gained events, a focus event is invoked when the component accepts the focus.voidAdds a listener to the pointer eventvoidAdds a listener to the pointer eventvoidAdds a listener to the pointer eventvoidAdds a listener to the pointer eventvoidaddPullToRefresh(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.voidRegisters interest in receiving callbacks for scroll gained events, a scroll event is invoked when the component is scrolled.voidAdds a listener to be notified when the state of this component is changed to and from initialized.voidManually announces text to native accessibility services, associating the announcement with this component when possible.voidbindProperty(String prop, BindTarget target) Binds the given property name to the given bind targetfinal booleanA 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 DimensionMethod that can be overriden to represent the actual size of the component when it differs from the desireable size for the viewportprotected voidremove this component from the painting queuevoidClears all client properties from this Componentbooleancontains(int x, int y) Returns true if the given absolute coordinate is contained in the ComponentbooleancontainsOrOwns(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.createStyleAnimation(String destUIID, int duration) Creates an animation that will transform the current component to the styling of the destination UIID when completed.protected voidAllows components to create a style of their own, this method cleans up state for the given styleprotected voidThis callback method indicates that a component drag has just entered this componentprotected voidThis 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 voiddragFinished(int x, int y) Callback indicating that the drag has finished either via drop or by releasing the componentprotected booleandraggingOver(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 voidInvoked 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 scrollingprotected voiddrawDraggedImage(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 indicationvoidPerforms 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 effectprotected voidCallback allowing a developer to track when the component gains focusprotected voidCallback allowing a developer to track wheh the component loses focusintReturns 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()intReturns 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()Returns the text that describes this component to assistive technologies.final StyleReturns 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.Returns the animation manager of the parent form or null if this component isn't currently associated with a formintgetBaseline(int width, int height) The baseline for the component text according to which it should be aligned with other components for best visual look.intReturns a constant indicating how the baseline varies with the size of the component.String[]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 boundClass[]Returns the types of the properties that are bindable within this componentprotected BorderNormally returns getStyle().getBorder() but some subclasses might use this to programmatically replace the border in runtime e.g.intReturns the gap to be left for the bottom scrollbar on the X axis.getBoundPropertyValue(String prop) Allows the binding code to extract the value of the propertyprotected RectangleReturns the component bounds which is sometimes more convenient than invoking getX/Y/Width/Height.Returns the bounds of this component in the provided Rectangle.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.Indicates the property within this component that should be bound to the cloud objectThe destination property of the CloudObjectReturns the Component Form or null if this Component is not added yet to a formSome components may optionally generate a state which can then be restored using setCompnentState().intGets the custom cursor for this component.static byteReturns the default translucency used in the#getDragImage()method.final Rectanglegets the Component dirty region, this method is for internal use only and SHOULD NOT be invoked by user code.Returns the Component Style for the disabled state allowing us to manipulate the look of the component when its disabledintGets the current dragged x values when the Component is being draggedintGets the current dragged y values when the Component is being draggedprotected ImageThis 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 operationprotected floatgetDragSpeed(boolean vertical) This method returns the dragging speed based on the latest dragged eventsbyteReturns the translucency used in the#getDragImage()method.Gets the delegate that handles the editing of this component.intReturns the component heightGets inline styles that are to be applied to all states of this component.Gets inline styles that are to be applied to the disabled state of this component.Gets inline styles that are to be applied to the pressed state of this component.Gets inline styles that are to be applied to the selected state of this component.Gets the theme that is used by inline styles to reference images.Gets inline styles that are to be applied to the unselected state of this component.intGets the inner height of this component.intGets the preferred height removing vertical padding.intGets the preferred width removing horizontal padding.intGets the inner width of this component.intGets x-coordinate of the inner bounds of this component.intGets the inner y-coordinate of the inner bounds of this component.Allows us to indicate the label associated with this component thus providing visual feedback related for this component e.g.getName()A component name allows us to easily identify the component within a dynamic UI.Gets the native overlay for this component.Allows us to determine which component will receive focus next when traversing with the down keyAllows us to determine which component will receive focus next when traversing with the left key.Allows us to determine which component will receive focus next when traversing with the right keyAllows us to determine which component will receive focus next when traversing with the up key.intGets the outer height of this component.intGets the preferred height including the vertical margins.intGets the preferred width including horizontal margins.intGets the outer width of this component.intGets the x-coordinate of the outer bounds of this component.intGets the Y-coordinate of the outer bounds of this component.getOwner()Gets the "owner" of this component as set by#setOwner(com.codename1.ui.Component).Returns the container in which this component is containedintHelper method to retrieve the preferred height of the component.Returns the Component Preferred Size, there is no guarantee the Component will be sized at its Preferred Size.Returns the preferred size string that can be used to specify the preferred size of the component using pixels or millimetres.intGets the preferred tab index of this component.intHelper method to retrieve the preferred width of the component.Returns the Component Style for the pressed state allowing us to manipulate the look of the component when it is pressedString[]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,ListCellRendererReturns the array of components that have an equal heightReturns the array of components that have an equal widthReturns the scrollable parent of this componentintScroll animation speed in milliseconds allowing a developer to slow down or accelerate the smooth animation modeReturns the Components dimension in scrolling, this is very similar to the preferred size aspect only it represents actual scrolling limits.intThis method is used internally by the look and feel to implement the fading scrollbar behavior.intIndicates the decrement units for the scroll opacityintIndicates 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.intIndicates 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.Allows determining the text for the select command used in the 3rd softbutton mode.Returns the Component Style for the selected state allowing us to manipulate the look of the component when it owns focusgetStyle()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.intGets the tab index of the component.intRecommended length for the tensile, -1 for defaultReturns text selection support object for this component.Returns
final StringgetUIID()Unique identifier for a component.This method should be used by the Component to retrieve the correct UIManager to work withfinal StyleReturns the Component Style for the unselected mode allowing us to manipulate the look of the componentgetVisibleBounds(Rectangle rect) Returns the component bounds for scrolling which might differ from the getBounds for large components into the provided rectangle.intgetWidth()Returns the component widthintgetX()Returns the current component x location relatively to its parent containerintgetY()Returns the component y location relatively to its parent containervoidgrowShrink(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.booleanPrevents key events from being grabbed for focus traversal.booleanChecks 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.booleanhasFocus()Returns true if the component has focusprotected voidHides the native overlay for this component.protected voidAllows components to create a style of their own, this method binds the listener to the style and installs a bg painterprotected voidinitDisabledStyle(Style disabledStyle) Can be overridden by subclasses to perform initialization when the disabled style is set to a new value.protected voidinitPressedStyle(Style pressedStyle) Can be overridden by subclasses to perform initialization when the pressed style is set to a new value.protected voidinitSelectedStyle(Style selectedStyle) Can be overridden by subclasses to perform initialization when the selected style is set to a new value.protected voidinitUnselectedStyle(Style unselectedStyle) Can be overridden by subclasses to perform initialization when the unselected style is set to a new value.protected voidAllows subclasses to create their own custom style types and install the background painter into thembooleanEnable the tensile drag to work even when a component doesn't have a scroll showable (scrollable flag still needs to be set to true)booleanPrevent a lead component hierarchy from this specific component, this allows a component within that hierarchy to still act as a standalone componentbooleanUsed as an optimization to mark that this component is currently being used as a cell rendererbooleanSearches the hierarchy of the component recursively to see if the given Container is one of the parents of this componentprotected booleanIndicates 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 booleanisDragAndDropOperation(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"booleanIndicates whether this component can be dragged in a drag and drop operation rather than scroll the parentprotected booleanisDragRegion(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.booleanIndicates 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 targetbooleanChecks to see if the component is editable.booleanChecks if the component is currently being edited.booleanIndicates whether component is enabled or disabled thus allowing us to prevent a component from receiving input events and indicate so visuallybooleanMakes 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.booleanReturns true if this component can receive focus and is enabledbooleanThis 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.booleanisHidden()Returns true if the component was explicitly hidden by the user.booleanisHidden(boolean checkParent) Checks if the component is hidden.booleanIndicates that this component and all its children should be hidden when the device is switched to landscape modebooleanIndicates that this component and all its children should be hidden when the device is switched to portrait modebooleanReturns
protected booleanprotected booleanIndicates if the component is in the initialized state, a component is initialized when its initComponent() method was invoked.booleanisOpaque()Checks whether the component's background should be painted.booleanChecks to see if this component is owned by the given other component.booleanreturns true if pinch will block drag and dropbooleanIndicates whether the component displays the material design ripple effectfinal booleanisRTL()Is the component a bidi RTL componentprotected booleanIndicates whether the component should/could scroll by default a component is not scrollable.booleanIndicate whether this component scroll is visiblestatic booleanChecks to see if this platform supports cursors.booleanIndicates that scrolling through the component should work as an animationbooleanIndicates whether scrolling this component should jump to a specific location in a gridprotected booleanReturns true if the component is interested in receiving drag/pointer release events even after the gesture exceeded its boundaries.booleanIndicates whether the component should "trigger" tactile touch when pressed by the user in a touch screen UI.booleanIndicates whether tensile drag (dragging beyond the boundry of the component and snapping back) is enabled for this component.final booleanChecks if this component should be traversable using the keyboard using tab, next, previous keys.booleanReturns whether the component is visible or notvoidkeyRepeated(int keyCode) If this Component is focused, the key repeat event will call this method.protected voidlongKeyPress(int keyCode) If this Component is focused this method is invoked when the user presses and holds the keyprotected voidonScrollX(int scrollX) This method can be overriden to receive scroll events, unlike overriding setScrollX it will receive all calls for scrolling.protected voidonScrollY(int scrollY) This method can be overriden to receive scroll events, unlike overriding setScrollY it will receive all calls for scrolling.protected voidonSetFocusable(boolean focusable) Since setFocusable is final this callback is invoked when focusable changes.protected voidThis method paints the Component background, it should be overriden by subclasses to perform custom background drawing.voidThis method paints all the parents Components Background.protected voidDraws the component border if such a border exists.protected voidDraws the component border background if such a border exists.final voidPaints this component as a root by going to all the parent components and setting the absolute translation based on coordinates and scroll status.final voidpaintComponent(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.voidPaints intersecting components that appear above this component.paintLock(boolean hardLock) This method locks the component so it will always paint the given image instead of running through its paint logic.voidReleases the paint lock image to allow paint to work as usual, see paintLock(boolean) for detailsvoidpaintRippleOverlay(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 voidPaints the UI for the scrollbars on the component, this will be invoked only for scrollable components.protected voidPaints the UI for the scrollbar on the X axis, this method allows component subclasses to customize the look of a scrollbarprotected voidPaints the UI for the scrollbar on the Y axis, this method allows component subclasses to customize the look of a scrollbarvoidpaintShadows(Graphics g, int relativeX, int relativeY) Paints the drop-shadow projections for this component based on its elevation value.static DimensionparsePreferredSize(String preferredSize, Dimension baseSize) Parses the preferred size given as a stringprotected booleanpinch(float scale) Invoked by subclasses interested in handling pinch to zoom events, if true is returned other drag events will not be broadcastprotected booleanpinch(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 broadcastprotected voidpinchReleased(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).voidpointerDragged(int[] x, int[] y) If this Component is focused, the pointer dragged event will call this methodvoidpointerHoverPressed(int[] x, int[] y) Invoked for devices where the pointer can hover without actually clicking the display.voidpointerPressed(int[] x, int[] y) If this Component is focused, the pointer pressed event will call this methodvoidpointerReleased(int[] x, int[] y) If this Component is focused, the pointer released event will call this methodvoidputClientProperty(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.voidMakes sure the component is up to date with the current theme, ONLY INVOKE THIS METHOD IF YOU CHANGED THE THEME!protected voidrefreshTheme(String id, boolean merge) Makes sure the component is up to date with the given UIIDvoidremove()This method will remove the Component from its parent.voidRemoves the listener from the drag finished eventvoidRemoves an action listener to drag over eventsvoidRemoves an action listener to drop events which are invoked when this component is dropped on a targetvoidDeregisters interest in receiving callbacks for focus gained eventsvoidRemoves the listener from the pointer eventvoidRemoves the listener from the pointer eventvoidRemoves the listener from the pointer eventvoidRemoves the listener from the pointer eventvoidDeregisters interest in receiving callbacks for scroll gained eventsvoidRemoves a listener from being notified when the state of this component is changed to and from initialized.voidrepaint()Repaint this Component, the repaint call causes a callback of the paint method on the event dispatch thread.voidrepaint(int x, int y, int w, int h) Repaints a specific region within the componentvoidChanges the current component to the focused component, will work only for a component that belongs to a parent form.protected voidRestores the state of the focusable flag to its default statebooleanChecks if the component responds to pointer events.voidscrollRectToVisible(int x, int y, int width, int height, Component coordinateSpace) Makes sure the component is visible in the scroll if this container is scrollableprotected voidscrollRectToVisible(Rectangle rect, Component coordinateSpace) Makes sure the component is visible in the scroll if this container is scrollablevoidsetAccessibilityText(String text) Sets the text that describes this component to assistive technologies.voidsetAlwaysTensile(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)voidsetBlockLead(boolean blockLead) Prevent a lead component hierarchy from this specific component, this allows a component within that hierarchy to still act as a standalone componentvoidsetBoundPropertyValue(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!voidsetCellRenderer(boolean cellRenderer) Used as an optimization to mark that this component is currently being used as a cell renderervoidsetCloudBoundProperty(String cloudBoundProperty) Indicates the property within this component that should be bound to the cloud objectvoidsetCloudDestinationProperty(String cloudDestinationProperty) The destination property of the CloudObjectvoidsetComponentState(Object state) If getComponentState returned a value the setter can update the value and restore the prior state.voidsetCursor(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 voidsetDefaultDragTransparency(byte defaultDragTransparency) Sets the default translucency of the#getDragImage()method.final voidsetDirtyRegion(Rectangle dirty) sets the Component dirty region, this method is for internal use only and SHOULD NOT be invoked by user code.voidsetDisabledStyle(Style style) Changes the Component disalbed Style by replacing the Component Style with the given StylevoidsetDraggable(boolean draggable) Indicates whether this component can be dragged in a drag and drop operation rather than scroll the parentvoidsetDragTransparency(byte dragTransparency) Sets the translucency of the#getDragImage()method.voidsetDropTarget(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 targetvoidsetEditingDelegate(Editable editable) Sets the editing delegate for this component.voidsetEnabled(boolean enabled) Indicates whether component is enabled or disabled thus allowing us to prevent a component from receiving input events and indicate so visuallyvoidsetFlatten(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.voidsetFocus(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 voidsetFocusable(boolean focusable) A simple setter to determine if this Component can get focusedvoidsetGrabsPointerEvents(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.voidsetHeight(int height) Sets the Component height, this method is exposed for the purpose of external layout managers and should not be invoked directly.voidsetHidden(boolean b) Makes the components preferred size equal 0 when hidden and restores it to the default size when not.voidsetHidden(boolean b, boolean changeMargin) Makes the components preferred size equal 0 when hidden and restores it to the default size when not.voidsetHideInLandscape(boolean hideInLandscape) Indicates that this component and all its children should be hidden when the device is switched to landscape modevoidsetHideInPortrait(boolean hideInPortrait) Indicates that this component and all its children should be hidden when the device is switched to portrait modevoidsetIgnorePointerEvents(boolean ignorePointerEvents) Parameters
protected voidsetInitialized(boolean initialized) Indicates if the component is in the initialized state, a component is initialized when its initComponent() method was invoked.voidsetInlineAllStyles(String styles) Registers inline styles that should be applied to all states of the component.voidsetInlineDisabledStyles(String styles) Registers inline styles that should be applied to the disabled state of the component.voidsetInlinePressedStyles(String styles) Registers inline styles that should be applied to the pressed state of the component.voidsetInlineSelectedStyles(String styles) Registers inline styles that should be applied to the selected state of the component.voidsetInlineStylesTheme(Resources inlineStylesTheme) Sets the theme that is used by inline styles to reference images.voidsetInlineUnselectedStyles(String styles) Registers inline styles that should be applied to the unselected state of the component.voidsetIsScrollVisible(boolean isScrollVisible) Set whether this component scroll is visiblevoidsetLabelForComponent(Label componentLabel) Allows us to indicate the label associated with this component thus providing visual feedback related for this component e.g.voidA component name allows us to easily identify the component within a dynamic UI.voidsetNextFocusDown(Component nextFocusDown) Allows us to determine which component will receive focus next when traversing with the down keyvoidsetNextFocusLeft(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.voidsetNextFocusRight(Component nextFocusRight) Allows us to determine which component will receive focus next when traversing with the right keyvoidsetNextFocusUp(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 voidsetOpaque(boolean opaque) Sets whether or not to paint the component background.voidSets the owner of this component to the specified component.voidsetPinchBlocksDragAndDrop(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).voidsetPreferredH(int preferredH) Helper method to set the preferred height of the component.voidSets the Component Preferred Size, there is no guarantee the Component will be sized at its Preferred Size.voidsetPreferredSizeStr(String value) Parameters
voidsetPreferredTabIndex(int index) Sets the preferred tab index of the component.voidsetPreferredW(int preferredW) Helper method to set the preferred width of the component.voidsetPressedStyle(Style style) Sets the Component Style for the pressed state allowing us to manipulate the look of the component when it is pressedvoidsetRippleEffect(boolean rippleEffect) Indicates whether the component displays the material design ripple effectvoidsetRTL(boolean rtl) Is the component a bidi RTL componentstatic voidsetSameHeight(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 voidsetSameSize(Component... c) This is identical to invoking#sameWidthfollowed by#sameHeightstatic voidsetSameWidth(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.voidsetScrollAnimationSpeed(int animationSpeed) Scroll animation speed in milliseconds allowing a developer to slow down or accelerate the smooth animation modevoidsetScrollOpacityChangeSpeed(int scrollOpacityChangeSpeed) Indicates the decrement units for the scroll opacityvoidSet the size for the scroll areavoidsetScrollVisible(boolean isScrollVisible) Set whether this component scroll is visibleprotected voidsetScrollX(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 voidsetScrollY(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.voidsetSelectCommandText(String selectText) Allows determining the text for the select command used in the 3rd softbutton mode.voidsetSelectedStyle(Style style) Changes the Component selected Style by replacing the Component Style with the given StylevoidSets the Component size, this method is exposed for the purpose of external layout managers and should not be invoked directly.voidsetSmoothScrolling(boolean smoothScrolling) Indicates that scrolling through the component should work as an animationvoidsetSnapToGrid(boolean snapToGrid) Indicates whether scrolling this component should jump to a specific location in a gridvoidsetTabIndex(int index) Sets the tab index of the component.voidsetTactileTouch(boolean tactileTouch) Indicates whether the component should "trigger" tactile touch when pressed by the user in a touch screen UI.voidsetTensileDragEnabled(boolean tensileDragEnabled) Indicates whether tensile drag (dragging beyond the boundry of the component and snapping back) is enabled for this component.voidsetTensileLength(int tensileLength) Recommended length for the tensile, -1 for defaultvoidsetTooltip(String tooltip) Parameters
final voidsetTraversable(boolean traversable) Sets whether this component is traversable using the keyboard using tab, next, previous keys.voidThis method sets the Component the Unique identifier.voidThis method sets the Component the Unique identifier.protected final voidsetUIIDFinal(String id) This method is the implementation of setUIID and is defined as final to allow invocation from constructors.voidsetUnselectedStyle(Style style) Changes the Component Style by replacing the Component Style with the given StylevoidsetVisible(boolean visible) Toggles visibility of the componentvoidsetWidth(int width) Sets the Component width, this method is exposed for the purpose of external layout managers and should not be invoked directly.voidsetX(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.voidsetY(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 booleanA 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 booleanA 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 booleanA 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 booleanA 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 voidCreates the native overlay for this component.voidIf the component#isEditable(), then this will start the editing process.voidstopEditing(Runnable onFinish) Stops the editing process.Convenience method that strips margin and padding from the component, and returns itself for chaining.voidstyleChanged(String propertyName, Style source) Invoked to indicate a change in a propertyName of a StyletoImage()Returns the component as an image.toString()Overriden to return a useful value for debugging purposesvoidunbindProperty(String prop, BindTarget target) Removes a bind target from the given property nameprotected voidUpdates the native overlay for this component.booleanvisibleBoundsContains(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, waitModifier and TypeMethodDescriptionprotected Objectclone()booleanIndicates whether some other object is "equal to" this one.final ClassgetClass()Returns the runtime class of an object.inthashCode()Returns a hash code value for the object.final voidnotify()Wakes up a single thread that is waiting on this object's monitor.final voidWakes up all threads that are waiting on this object's monitor.final voidwait()Causes current thread to wait until another thread invokes the method or the method for this object.final voidwait(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 voidwait(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.
-
Constructor Details
-
MultiList
Constructor that accepts a model for the list
Parameters
model: the model object to assign to the list
-
MultiList
public MultiList()Constructor for the GUI builder
-
-
Method Details
-
initComponent
protected void initComponent()Allows subclasses to bind functionality that relies on fully initialized and "ready for action" component state- Overrides:
initComponentin classComponent
-
deinitialize
protected void deinitialize()Description copied from class:ComponentInvoked 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:
deinitializein classComponent
-
getSelectedButton
Allows developers to customize the properties of the selected multi-button in code
Returns
the selected multi button
-
getUnselectedButton
Allows developers to customize the properties of the unselected multi-button in code
Returns
the unselected multi button
-
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:
getPropertyNamesin classComponent
-
getPropertyTypes
Matches the property names method (see that method for further details).
Returns
the types of the properties
- Overrides:
getPropertyTypesin classComponent
-
getPropertyValue
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:
getPropertyValuein classComponent
-
setPropertyValue
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:
setPropertyValuein classComponent
-
-