com.codename1.components.xmlview

Class XMLView

java.lang.Object

com.codename1.ui.Component

com.codename1.ui.Container

com.codename1.components.xmlview.XMLView

All Implemented Interfaces:

com.codename1.ui.animations.Animation, com.codename1.ui.events.StyleListener, java.lang.Iterable<com.codename1.ui.Component>

public class XMLView
extends com.codename1.ui.Container

A component that renders XML content as a visual component. Works like an HTML viewer, except that it is far more minimal, performant, and extensible.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	XMLView.ViewFactory Interface to be implemented by all view factories.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ASPECT_16X9 16:9 aspect ratio
static int	ASPECT_SQUARE 1:1 aspect ratio

Fields inherited from class com.codename1.ui.Component

BASELINE, BOTTOM, BRB_CENTER_OFFSET, BRB_CONSTANT_ASCENT, BRB_CONSTANT_DESCENT, BRB_OTHER, CENTER, 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, LEFT, RIGHT, TOP

Constructor Summary

Constructors

Constructor and Description
XMLView() Creates an XML view.

Method Summary

Modifier and Type	Method and Description
com.codename1.ui.Component	createView(com.codename1.xml.Element el) Creates a view for the given XML element.
com.codename1.ui.EncodedImage	getDefault16x9PlaceholderImage() Retrieves the placeholder for 16x9 images.
com.codename1.ui.EncodedImage	getDefaultSquarePlaceholderImage() Retrieves a placeholder image for the standard square image size.
com.codename1.ui.Image	getIcon(java.lang.String charCode, int width, int height) Gets image icon using the icon font.
com.codename1.ui.Image	getIcon(java.lang.String charCode, int width, int height, int color) Gets a font icon for a particular character code in a specified width, height, and color
com.codename1.ui.Image	getImage(java.lang.String url, java.lang.String placeholder, int aspectPreference) Gets an image from a particular URL and stretches it to the given aspect ratio.
com.codename1.ui.EncodedImage	getPlaceholderImage(java.lang.String name, int aspectPreference) Gets a placeholder image.
void	load(java.lang.String url, com.codename1.util.Callback<com.codename1.xml.Element> callback) Loads an XML page from a url.
void	registerViewFactory(java.lang.String tagName, XMLView.ViewFactory factory) Registers a view factory with the view.
void	setPlaceholderImage(java.lang.String name, com.codename1.ui.EncodedImage img) Sets a placeholder image.
void	setXML(com.codename1.xml.Element root) Sets the XML contents of the view.
void	setXML(com.codename1.xml.Element root, java.lang.String base) Sets the XML contents to view.
void	setXML(java.lang.String xml) Sets the XML contents of the view.
void	setXML(java.lang.String xml, java.lang.String base) Sets the XML contents of the view.
java.lang.String	toAbsoluteUrl(java.lang.String url) Converts a url to an absolute URL.

Methods inherited from class com.codename1.ui.Container

add, add, add, add, addComponent, addComponent, addComponent, addComponent, animateHierarchy, animateHierarchyAndWait, animateHierarchyFade, animateHierarchyFadeAndWait, animateLayout, animateLayoutAndWait, animateLayoutFade, animateLayoutFadeAndWait, animateUnlayout, animateUnlayoutAndWait, applyRTL, calcPreferredSize, cancelRepaints, clearClientProperties, contains, createAnimateMotion, dragInitiated, drop, encloseIn, encloseIn, findFirstFocusable, fireClicked, flushReplace, forceRevalidate, getBottomGap, getClosestComponentTo, getComponentAt, getComponentAt, getComponentCount, getComponentIndex, getGridPosX, getGridPosY, getLayout, getLayoutHeight, getLayoutWidth, getLeadComponent, getLeadParent, getScrollIncrement, getSideGap, getUIManager, initLaf, invalidate, isEnabled, isScrollableX, isScrollableY, isSelectableInteraction, iterator, keyPressed, keyReleased, layoutContainer, morph, morphAndWait, paint, paintComponentBackground, paintGlass, paramString, pointerHover, pointerPressed, refreshTheme, removeAll, removeComponent, replace, replace, replaceAndWait, replaceAndWait, replaceAndWait, revalidate, scrollComponentToVisible, setCellRenderer, setEnabled, setLayout, setLeadComponent, setScrollable, setScrollableX, setScrollableY, setScrollIncrement, setShouldCalcPreferredSize, setShouldLayout, setUIManager

Methods inherited from class com.codename1.ui.Component

addDragOverListener, addDropListener, addFocusListener, addPointerDraggedListener, addPointerPressedListener, addPointerReleasedListener, addPullToRefresh, addScrollListener, animate, bindProperty, calcScrollSize, contains, deinitialize, deinitializeCustomStyle, dragEnter, dragExit, dragFinished, draggingOver, drawDraggedImage, focusGained, focusLost, getAbsoluteX, getAbsoluteY, getAllStyles, getBaseline, getBaselineResizeBehavior, getBindablePropertyNames, getBindablePropertyTypes, getBorder, getBoundPropertyValue, getBounds, getClientProperty, getCloudBoundProperty, getCloudDestinationProperty, getComponentForm, getComponentState, getDirtyRegion, getDisabledStyle, getDraggedx, getDraggedy, getDragImage, getDragRegionStatus, getDragSpeed, getHeight, getLabelForComponent, getName, getNextFocusDown, getNextFocusLeft, getNextFocusRight, getNextFocusUp, getParent, getPreferredH, getPreferredSize, getPreferredW, getPressedStyle, getPropertyNames, getPropertyTypeNames, getPropertyTypes, getPropertyValue, getSameHeight, getSameWidth, getScrollable, getScrollAnimationSpeed, getScrollDimension, getScrollOpacity, getScrollOpacityChangeSpeed, getScrollX, getScrollY, getSelectCommandText, getSelectedRect, getSelectedStyle, getStyle, getTensileLength, getUIID, getUnselectedStyle, getVisibleBounds, getWidth, getX, getY, growShrink, handlesInput, hasFocus, initComponent, initCustomStyle, installDefaultPainter, isAlwaysTensile, isCellRenderer, isDragActivated, isDragAndDropOperation, isDraggable, isDragRegion, isDropTarget, isFlatten, isFocusable, isGrabsPointerEvents, isHideInPortrait, isInClippingRegion, isInitialized, isRTL, isScrollable, isScrollVisible, isSmoothScrolling, isSnapToGrid, isStickyDrag, isTactileTouch, isTactileTouch, isTensileDragEnabled, isVisible, keyRepeated, laidOut, longKeyPress, longPointerPress, onScrollX, onScrollY, paintBackground, paintBackgrounds, paintBorder, paintComponent, paintComponent, paintLock, paintLockRelease, paintScrollbars, paintScrollbarX, paintScrollbarY, pinch, pointerDragged, pointerDragged, pointerHoverPressed, pointerHoverReleased, pointerPressed, pointerReleased, pointerReleased, putClientProperty, refreshTheme, refreshTheme, removeDragOverListener, removeDropListener, removeFocusListener, removePointerDraggedListener, removePointerPressedListener, removePointerReleasedListener, removeScrollListener, repaint, repaint, requestFocus, resetFocusable, scrollRectToVisible, scrollRectToVisible, setAlwaysTensile, setBoundPropertyValue, setCloudBoundProperty, setCloudDestinationProperty, setComponentState, setDirtyRegion, setDisabledStyle, setDraggable, setDropTarget, setFlatten, setFocus, setFocusable, setGrabsPointerEvents, setHandlesInput, setHeight, setHideInPortrait, setInitialized, setIsScrollVisible, setLabelForComponent, setName, setNextFocusDown, setNextFocusLeft, setNextFocusRight, setNextFocusUp, setPreferredH, setPreferredSize, setPreferredW, setPressedStyle, setPropertyValue, setRTL, setSameHeight, setSameWidth, setScrollAnimationSpeed, setScrollOpacityChangeSpeed, setScrollSize, setScrollVisible, setScrollX, setScrollY, setSelectCommandText, setSelectedStyle, setSize, setSmoothScrolling, setSnapToGrid, setTactileTouch, setTensileDragEnabled, setTensileLength, setUIID, setUnselectedStyle, setVisible, setWidth, setX, setY, shouldBlockSideSwipe, styleChanged, toString, unbindProperty

Methods inherited from class java.lang.Object

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

Field Detail

ASPECT_SQUARE

public static final int ASPECT_SQUARE

1:1 aspect ratio

See Also:

Constant Field Values

ASPECT_16X9

public static final int ASPECT_16X9

16:9 aspect ratio

See Also:

Constant Field Values

Constructor Detail

XMLView

public XMLView()

Creates an XML view.

Method Detail

getDefaultSquarePlaceholderImage

public com.codename1.ui.EncodedImage getDefaultSquarePlaceholderImage()

Retrieves a placeholder image for the standard square image size.

Returns:

Default placeholder image.

getDefault16x9PlaceholderImage

public com.codename1.ui.EncodedImage getDefault16x9PlaceholderImage()

Retrieves the placeholder for 16x9 images.

Returns:

Default 16x9 placeholder image.

setPlaceholderImage

public void setPlaceholderImage(java.lang.String name,
                                com.codename1.ui.EncodedImage img)

Sets a placeholder image.

Parameters:

name - The name of the image.

img - The placeholder image.

getPlaceholderImage

public com.codename1.ui.EncodedImage getPlaceholderImage(java.lang.String name,
                                                         int aspectPreference)

Gets a placeholder image.

Parameters:

name - The name of the placeholder image.

aspectPreference - The aspect ratio preference. One of ASPECT_16X9 and ASPECT_SQUARE.

Returns:

Placeholder image with specified name and aspect ration preference.

getImage

public com.codename1.ui.Image getImage(java.lang.String url,
                                       java.lang.String placeholder,
                                       int aspectPreference)

Gets an image from a particular URL and stretches it to the given aspect ratio.

Parameters:

url - The URL of the image.

placeholder - The placeholder for the image.

aspectPreference - Preferred aspect ratio for the image.

Returns:

The image at the given URL.

getIcon

public com.codename1.ui.Image getIcon(java.lang.String charCode,
                                      int width,
                                      int height,
                                      int color)

Gets a font icon for a particular character code in a specified width, height, and color

Parameters:

charCode - The char code to display.

width - The width of the rendered icon.

height - The height of the rendered icon.

color - THe color of the rendered icon.

Returns:

Prerendered image of the icon.

getIcon

public com.codename1.ui.Image getIcon(java.lang.String charCode,
                                      int width,
                                      int height)

Gets image icon using the icon font. Default icon font is fontawesome.

Parameters:

charCode - The char code to render. This is font-dependent.

width - The width to render the image in px.

height - The height to render the image in px.

Returns:

The Image with the icon rendered with the given character code. From FontAwesome.

setXML

public void setXML(java.lang.String xml,
                   java.lang.String base)

Sets the XML contents of the view.

Parameters:

xml - The XML to render.

base - The base URL of the document. This is used to retrieve relative resources like images that are referenced in the document.

setXML

public void setXML(java.lang.String xml)

Sets the XML contents of the view. The base URL will be taken from the "base" attribute of either the root element, the head element, or the body element.

Parameters:

xml - The XML to load.

setXML

public void setXML(com.codename1.xml.Element root,
                   java.lang.String base)

Sets the XML contents to view.

Parameters:

root - The root XML element to display.

base - The base URL. Used for retrieving dependent resources like images that are referenced using a relative path.

setXML

public void setXML(com.codename1.xml.Element root)

Sets the XML contents of the view. The base URL will be extracted from the "base" attribute of the root element, the head element, or the body element.

Parameters:

root - The root element to display.

createView

public com.codename1.ui.Component createView(com.codename1.xml.Element el)

Creates a view for the given XML element. This will check each registered view factory to see if it supports the element, and will return the component generated by the first factory that supports it. If none can be found, then this will return null.

Parameters:

el - The XML element to convert to a view.

Returns:

The generated component or null if no factories are registered for this element.

toAbsoluteUrl

public java.lang.String toAbsoluteUrl(java.lang.String url)

Converts a url to an absolute URL. This is idempotent.

Parameters:

url - The URL to convert.

Returns:

The resulting absolute URL.

registerViewFactory

public void registerViewFactory(java.lang.String tagName,
                                XMLView.ViewFactory factory)

Registers a view factory with the view.

Parameters:

tagName - The tag name that the view factory processes.

factory - The view factory.

load

public void load(java.lang.String url,
                 com.codename1.util.Callback<com.codename1.xml.Element> callback)

Loads an XML page from a url. This will load asynchronously.

Parameters:

url - The URL to load.

callback - A callback that is called when loading is complete.