com.stimulsoft.report.barCodes

Class StiBarCode

java.lang.Object

com.stimulsoft.base.serializing.StiSerializedObject

com.stimulsoft.base.services.StiService

com.stimulsoft.report.StiBase

com.stimulsoft.report.components.StiComponent

com.stimulsoft.report.barCodes.StiBarCode

All Implemented Interfaces:

IStiJsonReportObject, IStiSerializable, IStiSerializableRef, IStiName, IStiBarCode, IStiBackColor, IStiBorder, IStiCanGrow, IStiCanShrink, IStiComponentGuid, IStiConditions, IStiEnumAngle, IStiExportImage, IStiExportImageExtended, IStiForeColor, IStiGrowToHeight, IStiHorAlignment, IStiInteraction, IStiPrintOn, IStiSelect, IStiShift, IStiUnitConvert, IStiVertAlignment, IStiReportProperty, IStiInherited, IStiStateSaveRestore, java.lang.Cloneable

public class StiBarCode
extends StiComponent
implements IStiBarCode, IStiBackColor, IStiForeColor, IStiExportImageExtended, IStiVertAlignment, IStiHorAlignment, IStiEnumAngle, IStiBorder

Field Summary

Fields inherited from class com.stimulsoft.report.components.StiComponent

canGrow, canShrink, componentPlacement, conditions, interaction, isRendered, page, parent, parentBookmark, PropertyComponentStyle, PropertyDelimiterComponent, PropertyDockable, PropertyInherited, PropertyLinked, PropertyLocked, PropertyMaxSize, PropertyMinSize, PropertyPlaceOnToolbox, PropertyRenderedCount, PropertyRestrictions, PropertySelectionTick, PropertyShowQuickButtons, PropertyUseParentStyles, top, width

Fields inherited from class com.stimulsoft.base.services.StiService

properties

Fields inherited from interface com.stimulsoft.base.serializing.interfaceobject.IStiSerializableRef

REFERENCE_EMPTY, REFERENCE_REPORT

Constructor Summary

Constructors

Constructor and Description
StiBarCode() Creates a new component of the type StiBarCode.
StiBarCode(StiRectangle rect) Creates a new component of the type StiBarCode.

Method Summary

Methods

Modifier and Type	Method and Description
StiAngle	getAngle() Gets or sets angle of a bar code rotation.
boolean	getAutoScale() Gets or sets value which indicates how bar code will scale its size.
StiColor	getBackColor() Gets or sets background color of bar code.
java.lang.String	GetBarCodeString()
StiBarCodeTypeService	getBarCodeType() Gets or sets type of the bar code.
StiBorder	getBorder() Gets or sets frame of the component.
boolean	getCanGrow() gets or sets a value which indicates that this object can grow.
boolean	getCanShrink() gets or sets value which indicates that this object can shrink.
StiBarCodeExpression	getCode() Gets or sets the expression to fill a code of bar code.
java.lang.String	getCodeValue() Gets or sets the component bar code.
StiRectangle	getDefaultClientRectangle() Gets or sets the default client area of a component.
StiFont	getFont() Gets or sets font of bar code.
StiColor	getForeColor() Gets or sets bar code color.
StiGetBarCodeEvent	getGetBarCodeEvent() Occurs when getting the code of bar code.
StiHorAlignment	getHorAlignment() Gets or sets the horizontal alignment of an barcode.
java.lang.String	getLocalizedCategory() Gets a localized name of the component category.
java.lang.String	getLocalizedName() Gets a localized component name.
boolean	getShowLabelText() Gets or sets value which indicates will this bar code show label text or no.
boolean	getShowQuietZones() Gets or sets value which indicates will this bar code show quiet zones or no.
int	getToolboxPosition() Gets value to sort a position in the toolbox.
StiVertAlignment	getVertAlignment() Gets or sets the vertical alignment of an barcode.
void	invokeEvents() Invokes all events for this components.
void	InvokeGetBarCode(StiComponent sender, StiValueEventArgs e) Raises the GetBarCode event.
boolean	isExportAsImage(StiExportFormat format)
void	LoadFromJsonObject(JSONObject jObject)
protected void	OnGetBarCode(StiValueEventArgs e) Raises the BarCode event.
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
void	setAngle(StiAngle value)
void	setAutoScale(boolean value)
void	setBackColor(StiColor value)
void	setBarCodeType(StiBarCodeTypeService value)
void	setBorder(StiBorder value)
void	setCanGrow(boolean value)
void	setCanShrink(boolean value)
void	setCode(StiBarCodeExpression value)
void	setCodeValue(java.lang.String value)
void	setFont(StiFont value)
void	setForeColor(StiColor value)
void	setGetBarCodeEvent(StiGetBarCodeEvent value)
void	setHorAlignment(StiHorAlignment value)
void	setShowLabelText(boolean value)
void	setShowQuietZones(boolean value)
void	setVertAlignment(StiVertAlignment value)

Methods inherited from class com.stimulsoft.report.components.StiComponent

addSize, AllowPrintOn, applyConditions, canContainIn, CheckForParentComponent, clearAllStates, ClearAllStates, ClearContents, clone, clone, ComponentToPage, ComponentToPage, ComponentToPage, convert, convert, decrementTop, doBookmark, DoBookmark, DockToContainer, DockToContainer, doGetBookmark, DoOffsetRect, fillComponentPlacement, getActualSize, getAfterPrintEvent, getAlias, getAllowDelete, getAnchor, getBeforePrintEvent, getBookmark, getBookmarkValue, getBottom, getBuilder, getClickEvent, getClientRectangle, getComponentPlacement, getComponentStyle, getComponentType, getConditions, getContainer, getCurrentBookmark, getDataBand, GetDataBand, getDelimiterComponent, getDisplayRectangle, getDisplayRectangle1, getDockable, getDockRegion, getDockRegion, getDockStyle, getDoubleClickEvent, getDrillDownParameters, getEnabled, getEvents, getForceRedrawAll, getgetBookmarkEvent, getgetDrillDownReportEvent, getgetHyperlinkEvent, getgetTagEvent, getgetToolTipEvent, getGroupHeaderBand, GetGroupHeaderBand, getGrowToHeight, getGuid, getHeight, getHighlightState, getHyperlink, getHyperlinkValue, getIgnoreNamingRule, getImage, getImage, getInherited, getInteraction, getInvalidateOnMouseOver, getIsCross, getIsDesigning, getIsEnabled, getIsEventEmpty, getIsExporting, getIsgetTagHandlerEmpty, getIsPrinting, getIsRendered, getIsSelected, getLeft, getLevel, getLinked, getLocked, getMaxSize, getMeasureGraphics, getMinSize, getMouseEnterEvent, getMouseLeaveEvent, getPage, getPaintRectangle, getPaintRectangle, getPaintRectangle, getParent, getParentBookmark, getPlaceOnToolbox, getPrintable, getPrintOn, getPriority, getQuickInfo, getRenderedCount, getReport, getRestrictions, getRight, getSelectionTick, getSelectRectangle, getServiceCategory, getServiceType, getShift, getShiftMode, getShowQuickButtons, getStates, getTag, getTagValue, getToolTip, getToolTipValue, getTop, getUseParentStyles, getWidth, incrementtTop, InternalRender, invert, InvokeAfterPrint, InvokeBeforePrint, InvokeBeginRender, InvokeClick, InvokeDoubleClick, InvokeEndRender, InvokegetBookmark, InvokegetDrillDownReport, InvokegetHyperlink, InvokegetTag, InvokegetToolTip, InvokeMouseEnter, InvokeMouseLeave, InvokePainted, invokePainting, isAutomaticDock, isDesigning, IsParentSelect, NewGuid, OnAfterPrint, OnBeforePrint, OnClick, OnDoubleClick, OngetBookmark, OngetDrillDownReport, OngetHyperlink, OngetTag, OngetToolTip, OnMouseEnter, OnMouseLeave, OnPainted, OnPainting, OnRemoveComponent, packService, PageToComponent, PageToComponent, paint, PlacedOnColumnBand, Prepare, render, reset, Reset, restoreState, RestoreState, saveState, select, setAfterPrintEvent, setAlias, setAnchor, setBeforePrintEvent, setBookmark, setBookmarkValue, setClickEvent, setClientRectangle, setComponentPlacement, setComponentStyle, setConditions, setCurrentBookmark, setDelimiterComponent, setDirectDisplayRectangle, setDisplayRectangle, setDockable, setDockStyle, setDoubleClickEvent, setDrillDownParameters, setEnabled, setgetBookmarkEvent, setgetDrillDownReportEvent, setgetHyperlinkEvent, setgetTagEvent, setgetToolTipEvent, setGrowToHeight, setGuid, setHeight, setHeightProp, setHighlightState, setHyperlink, setHyperlinkValue, setIgnoreNamingRule, setInherited, setInteraction, setIsRendered, setIsSelected, setLeft, setLeftProp, setLinked, setLocked, setMaxSize, setMinSize, setMouseEnterEvent, setMouseLeaveEvent, setName, setPage, setPaintRectangle, setParent, setParentBookmark, setPlaceOnToolbox, setPrintable, setPrintOn, setRenderedCount, setReport, SetReportVariables, setRestrictions, setSelectionTick, setSelectRectangle, setShift, setShiftMode, setShowQuickButtons, setStates, setTag, setTagValue, setToolTip, setToolTipValue, setTop, setTopProp, setUseParentStyles, setWidth, setWidthProp, toString, UnPrepare

Methods inherited from class com.stimulsoft.report.StiBase

getName, getServiceName

Methods inherited from class com.stimulsoft.base.services.StiService

getProperties, getServiceEnabled, getServiceInfo, isPropertyPresent, MemberwiseClone, properties, setProperties, setServiceEnabled

Methods inherited from class com.stimulsoft.base.serializing.StiSerializedObject

cleanReference, getReference, setReference

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.stimulsoft.report.components.interfaces.IStiExportImageExtended

getImage

Methods inherited from interface com.stimulsoft.report.components.interfaces.IStiExportImage

getImage

Constructor Detail

StiBarCode

public StiBarCode()

Creates a new component of the type StiBarCode.

StiBarCode

public StiBarCode(StiRectangle rect)

Creates a new component of the type StiBarCode.

Parameters:

rect - The rectangle describes size and position of the component.

Method Detail

getCanShrink

public boolean getCanShrink()

Description copied from class: StiComponent

gets or sets value which indicates that this object can shrink.

Specified by:

getCanShrink in interface IStiCanShrink

Overrides:

getCanShrink in class StiComponent

setCanShrink

public void setCanShrink(boolean value)

Specified by:

setCanShrink in interface IStiCanShrink

Overrides:

setCanShrink in class StiComponent

getCanGrow

public boolean getCanGrow()

Description copied from class: StiComponent

gets or sets a value which indicates that this object can grow.

Specified by:

getCanGrow in interface IStiCanGrow

Overrides:

getCanGrow in class StiComponent

setCanGrow

public void setCanGrow(boolean value)

Specified by:

setCanGrow in interface IStiCanGrow

Overrides:

setCanGrow in class StiComponent

getToolboxPosition

public int getToolboxPosition()

Gets value to sort a position in the toolbox.

Overrides:

getToolboxPosition in class StiComponent

getLocalizedCategory

public java.lang.String getLocalizedCategory()

Gets a localized name of the component category.

Overrides:

getLocalizedCategory in class StiBase

getLocalizedName

public java.lang.String getLocalizedName()

Gets a localized component name.

Overrides:

getLocalizedName in class StiBase

isExportAsImage

public boolean isExportAsImage(StiExportFormat format)

Specified by:

isExportAsImage in interface IStiExportImageExtended

Overrides:

isExportAsImage in class StiComponent

getAngle

public final StiAngle getAngle()

Gets or sets angle of a bar code rotation.

Specified by:

getAngle in interface IStiEnumAngle

setAngle

public final void setAngle(StiAngle value)

Specified by:

setAngle in interface IStiEnumAngle

getBorder

public final StiBorder getBorder()

Gets or sets frame of the component.

Specified by:

getBorder in interface IStiBorder

setBorder

public final void setBorder(StiBorder value)

Specified by:

setBorder in interface IStiBorder

getForeColor

public final StiColor getForeColor()

Gets or sets bar code color.

Specified by:

getForeColor in interface IStiForeColor

setForeColor

public final void setForeColor(StiColor value)

Specified by:

setForeColor in interface IStiForeColor

getBackColor

public final StiColor getBackColor()

Gets or sets background color of bar code.

Specified by:

getBackColor in interface IStiBackColor

setBackColor

public final void setBackColor(StiColor value)

Specified by:

setBackColor in interface IStiBackColor

getAutoScale

public boolean getAutoScale()

Gets or sets value which indicates how bar code will scale its size.

Specified by:

getAutoScale in interface IStiBarCode

setAutoScale

public void setAutoScale(boolean value)

Specified by:

setAutoScale in interface IStiBarCode

getShowLabelText

public boolean getShowLabelText()

Gets or sets value which indicates will this bar code show label text or no.

Specified by:

getShowLabelText in interface IStiBarCode

setShowLabelText

public void setShowLabelText(boolean value)

Specified by:

setShowLabelText in interface IStiBarCode

getShowQuietZones

public boolean getShowQuietZones()

Gets or sets value which indicates will this bar code show quiet zones or no.

setShowQuietZones

public void setShowQuietZones(boolean value)

getBarCodeType

public final StiBarCodeTypeService getBarCodeType()

Gets or sets type of the bar code.

Specified by:

getBarCodeType in interface IStiBarCode

setBarCodeType

public final void setBarCodeType(StiBarCodeTypeService value)

Specified by:

setBarCodeType in interface IStiBarCode

GetBarCodeString

public final java.lang.String GetBarCodeString()

Specified by:

GetBarCodeString in interface IStiBarCode

getFont

public StiFont getFont()

Gets or sets font of bar code.

setFont

public void setFont(StiFont value)

getHorAlignment

public final StiHorAlignment getHorAlignment()

Gets or sets the horizontal alignment of an barcode.

Specified by:

getHorAlignment in interface IStiHorAlignment

setHorAlignment

public final void setHorAlignment(StiHorAlignment value)

Specified by:

setHorAlignment in interface IStiHorAlignment

getVertAlignment

public final StiVertAlignment getVertAlignment()

Gets or sets the vertical alignment of an barcode.

Specified by:

getVertAlignment in interface IStiVertAlignment

setVertAlignment

public final void setVertAlignment(StiVertAlignment value)

Specified by:

setVertAlignment in interface IStiVertAlignment

getCodeValue

public final java.lang.String getCodeValue()

Gets or sets the component bar code.

setCodeValue

public final void setCodeValue(java.lang.String value)

getCode

public StiBarCodeExpression getCode()

Gets or sets the expression to fill a code of bar code.

setCode

public void setCode(StiBarCodeExpression value)

invokeEvents

public void invokeEvents()

Invokes all events for this components.

Overrides:

invokeEvents in class StiComponent

OnGetBarCode

protected void OnGetBarCode(StiValueEventArgs e)

Raises the BarCode event.

InvokeGetBarCode

public final void InvokeGetBarCode(StiComponent sender,
                    StiValueEventArgs e)

Raises the GetBarCode event.

getGetBarCodeEvent

public final StiGetBarCodeEvent getGetBarCodeEvent()

Occurs when getting the code of bar code.

setGetBarCodeEvent

public final void setGetBarCodeEvent(StiGetBarCodeEvent value)

getDefaultClientRectangle

public StiRectangle getDefaultClientRectangle()

Gets or sets the default client area of a component.

Overrides:

getDefaultClientRectangle in class StiComponent

SaveToJsonObject

public JSONObject SaveToJsonObject(StiJsonSaveMode mode)
                            throws JSONException

Specified by:

SaveToJsonObject in interface IStiJsonReportObject

Overrides:

SaveToJsonObject in class StiComponent

Throws:

JSONException

LoadFromJsonObject

public void LoadFromJsonObject(JSONObject jObject)
                        throws JSONException

Specified by:

LoadFromJsonObject in interface IStiJsonReportObject

Overrides:

LoadFromJsonObject in class StiComponent

Throws:

JSONException