org.fujion.barcode

Class BarCode

java.lang.Object

org.fujion.component.BaseComponent

org.fujion.component.BaseUIComponent

org.fujion.barcode.BarCode

All Implemented Interfaces:

org.fujion.ancillary.IDisable, org.fujion.ancillary.IElementIdentifier, org.fujion.client.IClientTransform, org.fujion.common.IAttributeMap<String,Object>

@Component(tag="barcode",
           widgetModule="fujion-barcode",
           widgetClass="BarCode",
           parentTag="*",
           description="Barcode component.")
public class BarCode
extends org.fujion.component.BaseUIComponent

Fujion wrapper for JsBarcode library.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BarCode.Format Supported barcode formats.

Nested classes/interfaces inherited from class org.fujion.component.BaseComponent

org.fujion.component.BaseComponent.ComponentReference<T extends org.fujion.component.BaseComponent>, org.fujion.component.BaseComponent.SubComponent

Field Summary

Fields inherited from interface org.fujion.ancillary.IElementIdentifier

log

Constructor Summary

Constructors

Constructor and Description
BarCode()
BarCode(BarCode.Format format)

Method Summary

Modifier and Type	Method and Description
boolean	getDisplayValue() Returns true if the value is to be displayed next to the barcode.
BarCode.Format	getFormat() Returns the barcode format.
String	getValue() Returns the value to be encoded.
boolean	isFlat() Returns whether or not to render guard bars.
void	setDisplayValue(boolean displayValue) Set to true if the value is to be displayed next to the barcode.
void	setFlat(boolean flat) Set to true to suppress rendering of guard bars.
void	setFormat(BarCode.Format format) Sets the barcode format.
void	setValue(String value) Sets the value to be encoded.

Methods inherited from class org.fujion.component.BaseUIComponent

_syncClasses, _syncStyles, addClass, addMask, addMask, addMask, addStyle, addStyles, afterRemoveChild, focus, getBalloon, getClasses, getContext, getCss, getDragid, getDropid, getFirstVisibleChild, getFirstVisibleChild, getFlex, getHeight, getHint, getKeycapture, getPopup, getStyle, getStyles, getTabindex, getWidth, hide, isDisabled, isVisible, print, print, removeClass, removeMask, removeStyle, reportSize, scrollIntoView, setBalloon, setClasses, setContext, setCss, setDisabled, setDragid, setDropid, setFlex, setFocus, setHeight, setHint, setKeycapture, setPopup, setStyles, setTabindex, setVisible, setWidth, show, toggleClass

Methods inherited from class org.fujion.component.BaseComponent

_attach, _initProps, addChild, addChild, addChild, addChildren, addComposite, addEventForward, addEventForward, addEventForward, addEventForward, addEventListener, addEventListener, addEventListener, addEventListener, afterAddChild, afterSetParent, areEqual, beforeAddChild, beforeRemoveChild, beforeSetParent, bind, bringToFront, defaultify, destroy, destroyChildren, detach, detachChildren, disableChildren, disableChildren, finalize, findAllNamed, findAttribute, findByName, findByName, findChild, findChildByData, findChildByLabel, findChildByLabel, fireEvent, fireEvent, fireEventToClient, fireEventToClient, getAncestor, getAncestor, getAttribute, getAttribute, getAttributes, getChildAt, getChildCount, getChildCount, getChildren, getChildren, getContent, getControllers, getData, getData, getDefinition, getFirstChild, getFirstChild, getId, getIndex, getLastChild, getLastController, getLastController, getName, getNamespace, getNextSibling, getNextSibling, getPage, getParent, getPreviousSibling, getPreviousSibling, getRoot, hasChildren, hasEventListener, hasEventListener, initialize, invoke, invoke, invoke, invoke, invoke, invokeIfAttached, isAncestor, isContainer, isContentSynced, isDead, isInitializing, isNamespace, isRendered, loadModule, loadModule, notifyAncestors, notifyDescendants, nullify, onAttach, onDestroy, propertyChange, propertyChange, removeChild, removeEventForward, removeEventForward, removeEventForward, removeEventForward, removeEventListener, removeEventListener, removeEventListener, removeEventListener, setContent, setContentSynced, setData, setIndex, setName, setNamespace, setParent, sub, swapChildren, sync, toString, trimify, validate, validate, validateChild, validateIsChild, validateName, validatePage, validateParent, wireController, wireController

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.fujion.ancillary.IElementIdentifier

transformForClient

Methods inherited from interface org.fujion.common.IAttributeMap

getAttribute, hasAttribute, removeAttribute, setAttribute

Constructor Detail

BarCode

public BarCode()

BarCode

public BarCode(BarCode.Format format)

Method Detail

getFormat

@Component.PropertyGetter(value="format",
                          description="The barcode format.")
public BarCode.Format getFormat()

Returns the barcode format.

Returns:

The barcode format.

setFormat

@Component.PropertySetter(value="format",
                          defaultValue="code128",
                          description="The barcode format.")
public void setFormat(BarCode.Format format)

Sets the barcode format. Resets the value property to null.

Parameters:

format - The barcode format.

getDisplayValue

@Component.PropertyGetter(value="displayValue",
                          description="If true, display the value in plain text.")
public boolean getDisplayValue()

Returns true if the value is to be displayed next to the barcode.

Returns:

True if the value is to be displayed next to the barcode.

setDisplayValue

@Component.PropertySetter(value="displayValue",
                          description="If true, display the value in plain text.")
public void setDisplayValue(boolean displayValue)

Set to true if the value is to be displayed next to the barcode.

Parameters:

displayValue - True if the value is to be displayed next to the barcode.

getValue

@Component.PropertyGetter(value="value",
                          description="The value to encode.")
public String getValue()

Returns the value to be encoded.

Returns:

The value to be encoded.

setValue

@Component.PropertySetter(value="value",
                          defer=true,
                          description="The value to encode.")
public void setValue(String value)

Sets the value to be encoded. The value is tested for validity for the current barcode format.

Parameters:

value - The value to be encoded.

Throws:

IllegalArgumentException - If value fails validation.

isFlat

@Component.PropertyGetter(value="flat",
                          description="If true, suppresses rendering of guard bars.")
public boolean isFlat()

Returns whether or not to render guard bars.

Returns:

True to suppress rendering of guard bars.

setFlat

@Component.PropertySetter(value="flat",
                          description="If true, suppresses rendering of guard bars.")
public void setFlat(boolean flat)

Set to true to suppress rendering of guard bars. For formats that do not use guard bars, this setting has no effect.

Parameters:

flat - True to suppress rendering of guard bars.