Package com.stimulsoft.report.crossTab

Class StiCrossHeader

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.components.simplecomponents.StiSimpleText

com.stimulsoft.report.components.simplecomponents.StiText

com.stimulsoft.report.crossTab.StiCrossField

com.stimulsoft.report.crossTab.StiCrossCell

com.stimulsoft.report.crossTab.StiCrossHeader

All Implemented Interfaces:

IStiAppExpressionCollection, IStiJsonReportObject, IStiSerializable, IStiSerializableRef, IStiSerializableToAttributes, IStiName, IStiAutoWidth, IStiBorder, IStiBreakable, IStiBrush, IStiCanGrow, IStiCanShrink, IStiComponentGuid, IStiConditions, IStiCrossTabField, IStiEditable, IStiExportImage, IStiExportImageExtended, IStiFont, IStiGlobalizedName, IStiGrowToHeight, IStiIndicator, IStiInteraction, IStiOnlyText, IStiPrintOn, IStiProcessAt, IStiProcessAtEnd, IStiSelect, IStiShift, IStiText, IStiTextBrush, IStiTextFormat, IStiTextHorAlignment, IStiTextOptions, IStiUnitConvert, IStiVertAlignment, IStiReportProperty, IStiGlobalizationProvider, IStiInherited, IStiStateSaveRestore, Cloneable

Direct Known Subclasses:

StiCrossColumn, StiCrossRow

public abstract class StiCrossHeader
extends StiCrossCell

Field Summary

Fields inherited from class com.stimulsoft.report.crossTab.StiCrossField

needClone, originalValue

Fields inherited from class com.stimulsoft.report.components.simplecomponents.StiText

font, PropertyAllowHtmlTags, PropertyAutoWidth, PropertyCanBreak, PropertyExportAsImage, PropertyLineSpacing, PropertyMargins, PropertyNullValue, PropertyRenderTo, PropertyShrinkFontToFit, PropertyShrinkFontToFitMinimumSize, PropertyTextQuality, PropertyType

Fields inherited from class com.stimulsoft.report.components.simplecomponents.StiSimpleText

PropertyGlobalizedName, PropertyMaxNumberOfLines, PropertyOnlyText, PropertyProcessAt, PropertyProcessingDuplicates, text, totalValueHelp

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

canGrow, canShrink, componentPlacement, conditions, currentPointer, eventFlags, expressions, interaction, isRendered, page, parent, parentBookmark, parentPointer, 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	Description
StiCrossHeader()

Method Summary

Modifier and Type	Method	Description
StiDisplayCrossValueExpression	getDisplayValue()	Gets or sets the expression that is used for calculation of a cell value which will be output in the table.
final StiGetDisplayCrossValueEvent	getGetDisplayCrossValueEvent()	Gets or sets a script of the event GetDisplayCrossValueEvent.
int	getHeaderLevel()
String	getHeaderValue()
boolean	getHideZeros()	Gets or sets value indicates that no need show zeroes.
boolean	getPrintOnAllPages()	Gets or sets value indicates that the component is printed on all pages.
boolean	getShowTotal()	Gets or sets value that indicates whether it is necessary to output totals or not.
final StiSortDirection	getSortDirection()	Gets or sets the sorting direction.
final StiSortType	getSortType()	Gets or sets the type of sorting.
final StiCrossTotal	getTotal()
final String	getTotalGuid()
final void	InvokeGetDisplayCrossValue(StiGetCrossValueEventArgs e)
boolean	isTotalVisible()
void	LoadFromJsonObject(JSONObject jObject)
protected void	OnGetDisplayCrossValue(StiGetCrossValueEventArgs e)	Raises the GetDisplayCrossValue event for this component.
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
void	setDisplayValue(StiDisplayCrossValueExpression value)
final void	setGetDisplayCrossValueEvent(StiGetDisplayCrossValueEvent value)
void	setHeaderLevel(int headerLevel)
void	setHeaderValue(String headerValue)
void	setHideZeros(boolean value)
void	setPrintOnAllPages(boolean value)
void	setShowTotal(boolean value)
final void	setSortDirection(StiSortDirection value)
final void	setSortType(StiSortType value)
void	setText(StiExpression value)
final void	setTotal(StiCrossTotal value)
final void	setTotalGuid(String value)
void	setValue(StiCrossValueExpression value)

Methods inherited from class com.stimulsoft.report.crossTab.StiCrossCell

getGetCrossValueEvent, getValue, InvokeGetCrossValue, OnGetCrossValue, setGetCrossValueEvent

Methods inherited from class com.stimulsoft.report.crossTab.StiCrossField

getAutoWidth, getBookmark, getCanBreak, getCanGrow, getCanShrink, getCellText, getDockStyle, getEditable, getEnabled, getExcelValue, getExportAsImage, getFont, getGetBookmarkEvent, getGlobalizedName, getGrowToHeight, getHeight, getHorAlignment, getLeft, getLinesOfUnderline, getLinked, getLocalizedCategory, getLocked, getMaxNumberOfLines, getMergeHeaders, getOnlyText, getPrintable, getPrintOn, getProcessAt, getProcessAtEnd, getProcessCellEvent, getProcessingDuplicates, getRenderTo, getRestrictions, getShiftMode, getShrinkFontToFit, getShrinkFontToFitMinimumSize, GetTextBoxFromField, getTextBrush, getTextFormat, getTop, getVertAlignment, getWidth, getWYSIWYG, isDisabledByCondition, setAlias, setAutoWidth, setBookmark, setCanBreak, setCanGrow, setCanShrink, setDisabledByCondition, setDockStyle, setEditable, setEnabled, setExcelValue, setExportAsImage, setFont, setGetBookmarkEvent, setGlobalizedName, setGrowToHeight, setHeight, setHorAlignment, setLeft, setLinesOfUnderline, setLinked, setLocked, setMaxNumberOfLines, setMergeHeaders, setName, setOnlyText, setPrintable, setPrintOn, setProcessAt, setProcessAtEnd, setProcessCellEvent, setProcessingDuplicates, setRenderTo, setRestrictions, setShiftMode, setShrinkFontToFit, setShrinkFontToFitMinimumSize, setTextBrush, setTextFormat, setTop, setVertAlignment, setWidth, setWYSIWYG, toString

Methods inherited from class com.stimulsoft.report.components.simplecomponents.StiText

Break, checkAllowHtmlTags, clone, convertTextBorders, convertTextMargins, getActualFont, getActualFont, getActualFont, getActualSize, getAllowHtmlTags, getAllStrings, getAngle, getBorder, getBrush, getClientRectangle, getComponentPlacement, getComponentStyle, getExcelDataValue, getFormat, getGetExcelValueEvent, getGuid, getIndicator, getLineSpacing, getLocalizedName, getMargins, getName, getNullValue, getRightToLeft, getString, getTagValue, getTextOptions, getTextQuality, getToolboxPosition, getType, getWordWrap, invokeEvents, InvokeGetExcelValue, InvokeRenderTo, isExportAsImage, measureString, OnGetExcelValue, packService, setAllowHtmlTags, setAngle, setBorder, setBrush, setExcelDataValue, setFormat, setGetExcelValueEvent, setIndicator, setLineSpacing, setMargins, setNullValue, setRightToLeft, setString, setTextOptions, setTextQuality, setType, setWordWrap

Methods inherited from class com.stimulsoft.report.components.simplecomponents.StiSimpleText

checkDuplicates, getComponentGuid, getEvents, getGetValueEvent, getLinesOfUnderlining, getQuickInfo, getText, getTextInternal, getTextValue, GetTextWithoutZero, getTotalValueHelp, InvokeGetValue, InvokeTextProcess, OnGetValue, ProcessText, RestoreState, saveState, SaveState, setComponentGuid, setGetValueEvent, setLinesOfUnderlining, setText, SetText, setTextInternal, SetTextInternal, setTextValue, setTotalValueHelp

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

addSize, AllowPrintOn, applyConditions, canContainIn, CheckForParentComponent, clearAllStates, ClearAllStates, ClearContents, clone, ComponentToPage, ComponentToPage, ComponentToPage, convert, convert, decrementTop, doBookmark, DoBookmark, DockToContainer, DockToContainer, doGetBookmark, DoOffsetRect, doPointer, doPointer, fillComponentPlacement, getAfterPrintEvent, getAlias, getAllowDelete, getAnchor, getBeforePrintEvent, getBookmarkValue, getBottom, getBuilder, getClickEvent, GetComponentStyle, getComponentType, getConditions, getContainer, getCurrentBookmark, getDataBand, GetDataBand, getDefaultClientRectangle, getDelimiterComponent, getDisplayRectangle, getDisplayRectangle1, getDockable, getDockRegion, getDockRegion, getDoubleClickEvent, getDrillDownParameters, getExpressions, getForceRedrawAll, getGetDrillDownReportEvent, getGetHyperlinkEvent, getGetTagEvent, getGetToolTipEvent, getGroupHeaderBand, GetGroupHeaderBand, getHighlightState, getHyperlink, getHyperlinkValue, getIgnoreNamingRule, getImage, getImage, getInherited, getInteraction, getInvalidateOnMouseOver, getIsCross, getIsDesigning, getIsEnabled, getIsEventEmpty, getIsExporting, getIsgetTagHandlerEmpty, getIsPrinting, getIsRendered, getIsSelected, getLevel, getMaxSize, getMeasureGraphics, getMinSize, getMouseEnterEvent, getMouseLeaveEvent, getPage, getPaintRectangle, getPaintRectangle, getPaintRectangle, getParent, getParentBookmark, getPlaceOnToolbox, getPointer, getPointerValue, getPriority, getRenderedCount, getReport, getRight, getSelectionTick, getSelectRectangle, getServiceCategory, getServiceType, getShift, getShowQuickButtons, getStates, getTag, getTagStrValue, getToolTip, getToolTipValue, getUseParentStyles, incrementtTop, InternalRender, invert, InvokeAfterPrint, InvokeBeforePrint, InvokeBeginRender, invokeBlockly, InvokeClick, InvokeDoubleClick, InvokeEndRender, InvokegetBookmark, InvokegetDrillDownReport, InvokegetHyperlink, InvokegetTag, InvokegetToolTip, InvokeMouseEnter, InvokeMouseLeave, InvokePainted, invokePainting, invokeScript, invokeScript, invokeScript, isAutomaticDock, isDesigning, IsParentSelect, NewGuid, OnAfterPrint, OnBeforePrint, OnClick, OnDoubleClick, OngetBookmark, OngetDrillDownReport, OngetHyperlink, OngetTag, OngetToolTip, OnMouseEnter, OnMouseLeave, OnPainted, OnPainting, OnRemoveComponent, PageToComponent, PageToComponent, paint, PlacedOnColumnBand, Prepare, render, reset, Reset, restoreState, select, setAfterPrintEvent, setAnchor, setBeforePrintEvent, setBookmarkValue, setClickEvent, setClientRectangle, setComponentPlacement, setComponentStyle, setConditions, setCurrentBookmark, setDelimiterComponent, setDirectDisplayRectangle, setDisplayRectangle, setDockable, setDoubleClickEvent, setDrillDownParameters, setExpressions, setGetDrillDownReportEvent, setGetHyperlinkEvent, setGetTagEvent, setGetToolTipEvent, setGuid, setHeightProp, setHighlightState, setHyperlink, setHyperlinkValue, setIgnoreNamingRule, setInherited, setInteraction, setIsRendered, setIsSelected, setLeftProp, setMaxSize, setMinSize, setMouseEnterEvent, setMouseLeaveEvent, setPage, setPaintRectangle, setParent, setParentBookmark, setPlaceOnToolbox, setPointer, setPointerValue, setRenderedCount, setReport, SetReportVariables, setSelectionTick, setSelectRectangle, setShift, setShowQuickButtons, setStates, setTag, setTagValue, setToolTip, setToolTipValue, setTopProp, setUseParentStyles, setWidthProp, UnPrepare

Methods inherited from class com.stimulsoft.report.StiBase

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.IStiBorder

getBorder, setBorder

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

getBrush, setBrush

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

getImage

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

getImage

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

getReference, setReference

Constructor Details

StiCrossHeader

public StiCrossHeader()

Method Details

OnGetDisplayCrossValue

protected void OnGetDisplayCrossValue(StiGetCrossValueEventArgs e)

Raises the GetDisplayCrossValue event for this component.

InvokeGetDisplayCrossValue

public final void InvokeGetDisplayCrossValue(StiGetCrossValueEventArgs e)

getGetDisplayCrossValueEvent

public final StiGetDisplayCrossValueEvent getGetDisplayCrossValueEvent()

Gets or sets a script of the event GetDisplayCrossValueEvent.

setGetDisplayCrossValueEvent

public final void setGetDisplayCrossValueEvent(StiGetDisplayCrossValueEvent value)

setText

public void setText(StiExpression value)

Specified by:

setText in interface IStiText

Overrides:

setText in class StiCrossCell

setValue

public void setValue(StiCrossValueExpression value)

Overrides:

setValue in class StiCrossCell

getDisplayValue

public StiDisplayCrossValueExpression getDisplayValue()

Gets or sets the expression that is used for calculation of a cell value which will be output in the table.

setDisplayValue

public void setDisplayValue(StiDisplayCrossValueExpression value)

getHideZeros

public boolean getHideZeros()

Description copied from class: StiSimpleText

Gets or sets value indicates that no need show zeroes.

Specified by:

getHideZeros in interface IStiText

Overrides:

getHideZeros in class StiSimpleText

setHideZeros

public void setHideZeros(boolean value)

Specified by:

setHideZeros in interface IStiText

Overrides:

setHideZeros in class StiSimpleText

getTotal

public final StiCrossTotal getTotal()

setTotal

public final void setTotal(StiCrossTotal value)

getTotalGuid

public final String getTotalGuid()

setTotalGuid

public final void setTotalGuid(String value)

getShowTotal

public boolean getShowTotal()

Gets or sets value that indicates whether it is necessary to output totals or not.

setShowTotal

public void setShowTotal(boolean value)

getSortDirection

public final StiSortDirection getSortDirection()

Gets or sets the sorting direction.

setSortDirection

public final void setSortDirection(StiSortDirection value)

getSortType

public final StiSortType getSortType()

Gets or sets the type of sorting.

setSortType

public final void setSortType(StiSortType value)

getPrintOnAllPages

public boolean getPrintOnAllPages()

Gets or sets value indicates that the component is printed on all pages.

setPrintOnAllPages

public void setPrintOnAllPages(boolean value)

isTotalVisible

public boolean isTotalVisible()

getHeaderLevel

public int getHeaderLevel()

Returns:

the headerLevel

setHeaderLevel

public void setHeaderLevel(int headerLevel)

Parameters:

headerLevel - the headerLevel to set

getHeaderValue

public String getHeaderValue()

Returns:

the headerValue

setHeaderValue

public void setHeaderValue(String headerValue)

Parameters:

headerValue - the headerValue to set

SaveToJsonObject

public JSONObject SaveToJsonObject(StiJsonSaveMode mode)
                            throws JSONException

Specified by:

SaveToJsonObject in interface IStiJsonReportObject

Overrides:

SaveToJsonObject in class StiCrossCell

Throws:

JSONException

LoadFromJsonObject

public void LoadFromJsonObject(JSONObject jObject)
                        throws JSONException

Specified by:

LoadFromJsonObject in interface IStiJsonReportObject

Overrides:

LoadFromJsonObject in class StiCrossCell

Throws:

JSONException