|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.stimulsoft.base.serializing.StiSerializedObject
com.stimulsoft.base.services.StiService
com.stimulsoft.report.StiBase
com.stimulsoft.report.components.StiComponent
com.stimulsoft.report.components.complexcomponents.StiContainer
com.stimulsoft.report.components.bands.StiBand
com.stimulsoft.report.components.bands.StiDynamicBand
com.stimulsoft.report.components.bands.StiHeaderBand
com.stimulsoft.report.components.crossBands.StiCrossHeaderBand
public class StiCrossHeaderBand
The class describes the Cross Header Band.
| Field Summary |
|---|
| Fields inherited from class com.stimulsoft.report.components.bands.StiHeaderBand |
|---|
keepHeaderTogether |
| Fields inherited from class com.stimulsoft.report.components.complexcomponents.StiContainer |
|---|
border, brush, collapsingIndex, components, ParentComponentIsBand, ParentComponentIsCrossBand |
| Fields inherited from class com.stimulsoft.report.components.StiComponent |
|---|
canGrow, canShrink, componentPlacement, conditions, currentPointer, expressions, interaction, isRendered, page, parent, parentBookmark, parentPointer, top, width |
| Fields inherited from interface com.stimulsoft.base.serializing.interfaceobject.IStiSerializableRef |
|---|
REFERENCE_EMPTY, REFERENCE_REPORT |
| Constructor Summary | |
|---|---|
StiCrossHeaderBand()
Creates a new component of the type StiCrossHeaderBand. |
|
StiCrossHeaderBand(StiRectangle rect)
Creates a component of the type StiCrossHeaderBand with specified location. |
|
| Method Summary | |
|---|---|
float |
getBreakIfLessThan()
Gets or sets value which indicates how much free space is on a page (in per cent) should be reserved for formation of a new page or a new column. |
boolean |
getCanBreak()
Gets or sets value which indicates whether the component can or cannot break its contents on several pages. |
StiRectangle |
getDefaultClientRectangle()
Gets or sets the default client area of a component. |
StiRectangle |
getDisplayRectangle()
Gets or sets a rectangle of the component which it fills. |
StiDockStyle |
getDockStyle()
Gets or sets a type of the component docking. |
boolean |
getGrowToHeight()
gets or sets a value which indicates that the height of this component increases/decreases to the bottom of a container. |
double |
getHeaderSize()
Gets the header height. |
double |
getHeight()
|
boolean |
getIsCross()
Gets value, indicates that this cross is the component. |
java.lang.String |
getLocalizedCategory()
Gets a localized name of the component category. |
java.lang.String |
getLocalizedName()
Gets a localized component name. |
double |
getMaxHeight()
Gets or sets maximal height of band. |
StiSize |
getMaxSize()
gets or sets maximal size. |
double |
getMaxWidth()
Gets or sets maximal width of band. |
double |
getMinHeight()
Gets or sets minimal height of band. |
StiSize |
getMinSize()
gets or sets minimal size. |
double |
getMinWidth()
Gets or sets minimal width of band. |
boolean |
getNewColumnAfter()
If the value of this property is true, then, after output of a band, a new column will be generated. |
boolean |
getNewColumnBefore()
If the value of this property is true, then, before output of a band, a new column will be generated. |
boolean |
getNewPageAfter()
If the value of this property is true, then, after output of a band, a new page will be generated. |
boolean |
getNewPageBefore()
If the value of this property is true, then, before output of a band, a new page will be generated. |
boolean |
getPrintAtBottom()
Gets or sets value indicates that the footer is printed at bottom of page. |
boolean |
getPrintIfEmpty()
Gets or sets value indicates that the header if data not present. |
StiPrintOnType |
getPrintOn()
gets or sets a value which indicates on what pages component will be printed. |
boolean |
getPrintOnAllPages()
Gets or sets value indicates that the component is printed on all pages. |
StiPrintOnEvenOddPagesType |
getPrintOnEvenOddPages()
Gets or sets value indicates that the component is printed on even-odd pages. |
int |
getPriority()
Gets a component priority. |
boolean |
getResetPageNumber()
Allows to reset page number on this band. |
StiRectangle |
getSelectRectangle()
Gets or sets a rectangle of the component selection. |
boolean |
getSkipFirst()
If the value of this property is true, then, a new page/column will be generated only starting from the second case. |
boolean |
getStartNewPage()
Gets or sets value indicates that it is necessary to print every new string on a new page. |
float |
getStartNewPageIfLessThan()
Gets or sets value which indicates how much free space on a page (in percentage terms) should be reserved for formation of a new page. |
int |
getToolboxPosition()
Gets value to sort a position in the toolbox. |
double |
getWidth()
gets or sets width of a component. |
void |
LoadFromJsonObject(JSONObject jObject)
|
JSONObject |
SaveToJsonObject(StiJsonSaveMode mode)
|
void |
setBreakIfLessThan(float value)
|
void |
setCanBreak(boolean value)
Gets or sets value which indicates whether the component can or cannot break its contents on several pages. |
void |
setDisplayRectangle(StiRectangle value)
|
void |
setDockStyle(StiDockStyle value)
|
void |
setGrowToHeight(boolean value)
|
void |
setHeight(double value)
|
void |
setMaxHeight(double value)
|
void |
setMaxSize(StiSize value)
|
void |
setMaxWidth(double value)
|
void |
setMinHeight(double value)
|
void |
setMinSize(StiSize value)
|
void |
setMinWidth(double value)
|
void |
setNewColumnAfter(boolean value)
|
void |
setNewColumnBefore(boolean value)
|
void |
setNewPageAfter(boolean value)
|
void |
setNewPageBefore(boolean value)
|
void |
setPrintAtBottom(boolean value)
|
void |
setPrintIfEmpty(boolean value)
|
void |
setPrintOn(StiPrintOnType value)
|
void |
setPrintOnAllPages(boolean value)
|
void |
setPrintOnEvenOddPages(StiPrintOnEvenOddPagesType value)
|
void |
setResetPageNumber(boolean value)
|
void |
setSelectRectangle(StiRectangle value)
Returns the GroupHeaderBand in which the component is loc * null, if nothing is located. |
void |
setSkipFirst(boolean value)
|
void |
setStartNewPage(boolean value)
|
void |
setStartNewPageIfLessThan(float value)
|
void |
setWidth(double value)
|
| Methods inherited from class com.stimulsoft.report.components.bands.StiHeaderBand |
|---|
clone, getComponentType, getHeaderBandInfoV1, getHeaderBandInfoV2, getHeaderEndColor, getHeaderStartColor, getKeepHeaderTogether, setKeepHeaderTogether |
| Methods inherited from class com.stimulsoft.report.components.bands.StiDynamicBand |
|---|
Break |
| Methods inherited from class com.stimulsoft.report.components.bands.StiBand |
|---|
canContainIn, clone, getBandInfoV2, getCanGrow, getFooterSize, GetHeaderText, getLeft, getNestedLevel, getPrintable, getQuickInfo, getRectangleMoveComponent, getShiftMode, getTop, isAutomaticDock, setCanGrow, setDirectDisplayRectangle, setLeft, setPrintable, setRectangleMoveComponent, setShiftMode, setTop |
| 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, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface com.stimulsoft.base.serializing.interfaceobject.IStiSerializableRef |
|---|
getReference, setReference |
| Constructor Detail |
|---|
public StiCrossHeaderBand()
public StiCrossHeaderBand(StiRectangle rect)
rect - The rectangle describes size and position of the component.| Method Detail |
|---|
public boolean getNewPageBefore()
StiDynamicBand
getNewPageBefore in interface IStiPageBreakgetNewPageBefore in class StiDynamicBandpublic void setNewPageBefore(boolean value)
setNewPageBefore in interface IStiPageBreaksetNewPageBefore in class StiDynamicBandpublic boolean getNewPageAfter()
StiDynamicBand
getNewPageAfter in interface IStiPageBreakgetNewPageAfter in class StiDynamicBandpublic void setNewPageAfter(boolean value)
setNewPageAfter in interface IStiPageBreaksetNewPageAfter in class StiDynamicBandpublic boolean getNewColumnBefore()
StiDynamicBand
getNewColumnBefore in interface IStiPageBreakgetNewColumnBefore in class StiDynamicBandpublic void setNewColumnBefore(boolean value)
setNewColumnBefore in interface IStiPageBreaksetNewColumnBefore in class StiDynamicBandpublic boolean getNewColumnAfter()
StiDynamicBand
getNewColumnAfter in interface IStiPageBreakgetNewColumnAfter in class StiDynamicBandpublic void setNewColumnAfter(boolean value)
setNewColumnAfter in interface IStiPageBreaksetNewColumnAfter in class StiDynamicBandpublic boolean getSkipFirst()
StiDynamicBand
getSkipFirst in interface IStiPageBreakgetSkipFirst in class StiDynamicBandpublic void setSkipFirst(boolean value)
setSkipFirst in interface IStiPageBreaksetSkipFirst in class StiDynamicBandpublic float getBreakIfLessThan()
StiDynamicBand
getBreakIfLessThan in interface IStiPageBreakgetBreakIfLessThan in class StiDynamicBandpublic void setBreakIfLessThan(float value)
setBreakIfLessThan in interface IStiPageBreaksetBreakIfLessThan in class StiDynamicBandpublic boolean getGrowToHeight()
StiComponent
getGrowToHeight in interface IStiGrowToHeightgetGrowToHeight in class StiBandpublic void setGrowToHeight(boolean value)
setGrowToHeight in interface IStiGrowToHeightsetGrowToHeight in class StiBandpublic boolean getResetPageNumber()
StiHeaderBand
getResetPageNumber in interface IStiResetPageNumbergetResetPageNumber in class StiHeaderBandpublic void setResetPageNumber(boolean value)
setResetPageNumber in interface IStiResetPageNumbersetResetPageNumber in class StiHeaderBandpublic boolean getStartNewPage()
StiHeaderBand
getStartNewPage in interface IStiStartNewPagegetStartNewPage in class StiHeaderBandpublic void setStartNewPage(boolean value)
setStartNewPage in interface IStiStartNewPagesetStartNewPage in class StiHeaderBandpublic float getStartNewPageIfLessThan()
StiHeaderBand
getStartNewPageIfLessThan in interface IStiStartNewPagegetStartNewPageIfLessThan in class StiHeaderBandpublic void setStartNewPageIfLessThan(float value)
setStartNewPageIfLessThan in interface IStiStartNewPagesetStartNewPageIfLessThan in class StiHeaderBandpublic boolean getPrintAtBottom()
StiDynamicBand
getPrintAtBottom in interface IStiPrintAtBottomgetPrintAtBottom in class StiDynamicBandpublic void setPrintAtBottom(boolean value)
setPrintAtBottom in interface IStiPrintAtBottomsetPrintAtBottom in class StiDynamicBandpublic boolean getCanBreak()
StiHeaderBand
getCanBreak in interface IStiBreakablegetCanBreak in class StiHeaderBandpublic void setCanBreak(boolean value)
StiDynamicBand
setCanBreak in interface IStiBreakablesetCanBreak in class StiHeaderBandpublic boolean getPrintOnAllPages()
StiHeaderBand
getPrintOnAllPages in interface IStiPrintOnAllPagesgetPrintOnAllPages in class StiHeaderBandpublic void setPrintOnAllPages(boolean value)
setPrintOnAllPages in interface IStiPrintOnAllPagessetPrintOnAllPages in class StiHeaderBandpublic boolean getPrintIfEmpty()
StiHeaderBand
getPrintIfEmpty in interface IStiPrintIfEmptygetPrintIfEmpty in class StiHeaderBandpublic void setPrintIfEmpty(boolean value)
setPrintIfEmpty in interface IStiPrintIfEmptysetPrintIfEmpty in class StiHeaderBandpublic StiPrintOnEvenOddPagesType getPrintOnEvenOddPages()
StiHeaderBand
getPrintOnEvenOddPages in interface IStiPrintOnEvenOddPagesgetPrintOnEvenOddPages in class StiHeaderBandpublic void setPrintOnEvenOddPages(StiPrintOnEvenOddPagesType value)
setPrintOnEvenOddPages in interface IStiPrintOnEvenOddPagessetPrintOnEvenOddPages in class StiHeaderBandpublic StiPrintOnType getPrintOn()
StiComponent
getPrintOn in interface IStiPrintOngetPrintOn in class StiComponentpublic void setPrintOn(StiPrintOnType value)
setPrintOn in interface IStiPrintOnsetPrintOn in class StiComponentpublic int getToolboxPosition()
getToolboxPosition in class StiHeaderBandpublic int getPriority()
getPriority in class StiHeaderBandpublic java.lang.String getLocalizedCategory()
getLocalizedCategory in class StiBandpublic java.lang.String getLocalizedName()
getLocalizedName in class StiHeaderBandpublic boolean getIsCross()
getIsCross in class StiComponentpublic StiDockStyle getDockStyle()
getDockStyle in class StiBandpublic void setDockStyle(StiDockStyle value)
setDockStyle in class StiBandpublic StiSize getMinSize()
StiComponent
getMinSize in class StiBandpublic void setMinSize(StiSize value)
setMinSize in class StiBandpublic StiSize getMaxSize()
StiComponent
getMaxSize in class StiBandpublic void setMaxSize(StiSize value)
setMaxSize in class StiBandpublic double getMinWidth()
public void setMinWidth(double value)
public double getMaxWidth()
public void setMaxWidth(double value)
public double getMaxHeight()
StiBand
getMaxHeight in class StiBandpublic void setMaxHeight(double value)
setMaxHeight in class StiBandpublic double getMinHeight()
StiBand
getMinHeight in class StiBandpublic void setMinHeight(double value)
setMinHeight in class StiBandpublic double getWidth()
StiComponent
getWidth in class StiBandpublic void setWidth(double value)
setWidth in class StiBandpublic double getHeight()
getHeight in class StiComponentpublic void setHeight(double value)
setHeight in class StiComponentpublic StiRectangle getDefaultClientRectangle()
getDefaultClientRectangle in class StiBandpublic StiRectangle getSelectRectangle()
getSelectRectangle in class StiBandpublic void setSelectRectangle(StiRectangle value)
StiComponent
setSelectRectangle in class StiBandpublic StiRectangle getDisplayRectangle()
getDisplayRectangle in class StiBandpublic void setDisplayRectangle(StiRectangle value)
setDisplayRectangle in class StiBandpublic double getHeaderSize()
getHeaderSize in class StiBand
public JSONObject SaveToJsonObject(StiJsonSaveMode mode)
throws JSONException
SaveToJsonObject in interface IStiJsonReportObjectSaveToJsonObject in class StiHeaderBandJSONException
public void LoadFromJsonObject(JSONObject jObject)
throws JSONException
LoadFromJsonObject in interface IStiJsonReportObjectLoadFromJsonObject in class StiHeaderBandJSONException
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||