|
Style Intelligence v12.0 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectinetsoft.uql.asset.AbstractAssetEngine
inetsoft.report.internal.StyleCore
inetsoft.report.ReportSheet
inetsoft.report.TabularSheet
inetsoft.report.ParameterSheet
public class ParameterSheet
A ParameterSheet contains the definition for a report parameter page. It can be used for prompting report parameter values.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class inetsoft.report.internal.StyleCore |
|---|
inetsoft.report.internal.StyleCore.ActionScriptable |
| Nested classes/interfaces inherited from class inetsoft.uql.asset.AbstractAssetEngine |
|---|
AbstractAssetEngine.ReportSheetDependencyFinder, AbstractAssetEngine.SheetTransformListener, AbstractAssetEngine.StorageChangeListener |
| Field Summary | |
|---|---|
static String |
PARAMETER_SHEET
Parameter sheet name. |
static String |
STAGE_FLOW_LEVEL
Stage flow & level name. |
static String |
STAGE_LEVEL
Stage level name. |
| Fields inherited from class inetsoft.report.ReportSheet |
|---|
BODY, DEFAULT_FOOTER, DEFAULT_HEADER, DOWN, EVEN_PAGE_FOOTER, EVEN_PAGE_HEADER, FIRST_PAGE_FOOTER, FIRST_PAGE_HEADER, ODD_PAGE_FOOTER, ODD_PAGE_HEADER, PAINTER_BREAKABLE, PAINTER_NON_BREAK, TABLE_EQUAL_WIDTH, TABLE_FIT_CONTENT, TABLE_FIT_CONTENT_1PP, TABLE_FIT_CONTENT_PAGE, TABLE_FIT_PAGE, UP, WRAP_BOTH, WRAP_LEFT, WRAP_NONE, WRAP_RIGHT, WRAP_TOP_BOTTOM |
| Fields inherited from class inetsoft.report.internal.StyleCore |
|---|
advanceLine, alignment, anchor, autosize, background, bg, bgimage, bglayout, bgsize, burstInfo, chartinfo, cmargin, COMPLETED, contexts, current, currFooter, currFrame, currHeader, DESIGN_MODE, elemFooter, elemHeader, evenFooter, evenHeader, firstFooter, firstHeader, font, footerElements, footerFromEdge, foreground, formatmap, frames, g_pmargin, header, headerElements, headerFromEdge, headingCnt, headingMap, hfFmt, hindent, horFlow, idmap, indent, initCalled, initCmd, initScript, justify, lastHead, lineH, LIVE_MODE, loadCmd, loadScript, locale, margin, MORE_ELEM, MORE_FLOW, nextOrient, npframes, nplayout, numHeadingMap, oddFooter, oddHeader, orphan, overrideFooter, overrideFooterContinue, overrideHeader, overrideHeaderContinue, padding, pageBox, pagebreakCmd, pagebreakScript, painterLayout, painterMargin, parameters, parentElem, pglayout, pgStart, pgTotal, pmargin, presentermap, printBox, printCmd, printHead, printMode, printScript, prop, psheet, queries, reportmode, rewinded, RUN_MODE, runningScript, runningTotals, scriptenv, secHeadingMap, secNumHeadingMap, sepadv, spacing, tableadv, tableorphan, tableW, tabStops, textadv, wrapping |
| Fields inherited from class inetsoft.uql.asset.AbstractAssetEngine |
|---|
admin, catalog, editing, istore, LOCAL, parent, scopes |
| Fields inherited from interface inetsoft.uql.XQueryRepository |
|---|
GLOBAL_SCOPE, LOCAL_QUERY, LOCAL_SCOPE, NORMAL_QUERY |
| Fields inherited from interface inetsoft.report.internal.ParameterSheetRepository |
|---|
EMBED_PARAMETER_SHEET, EMBED_SECTION |
| Fields inherited from interface inetsoft.uql.asset.AssetRepository |
|---|
ASSET_ERRORS, COMPONENT_SCOPE, GLOBAL_SCOPE, IGNORE_PERM, LOCAL_QUERY, QUERY_SCOPE, REPORT_SCOPE, REPORT_WORKSHEET, REPOSITORY_SCOPE, TEMPORARY_SCOPE, USER_SCOPE |
| Constructor Summary | |
|---|---|
ParameterSheet()
|
|
| Method Summary | |
|---|---|
void |
addStagedParameterFlow(int index,
inetsoft.report.parameter.StagedParameterFlow sflow)
Add a staged parameter flow on the specified index. |
void |
addStagedParameterFlow(inetsoft.report.parameter.StagedParameterFlow sflow)
Add a staged parameter flow. |
Object |
clone()
Make a copy of this report. |
int |
getCurrentStagedFlow(String elem)
Get staged parameter flow this element was in. |
Enumeration |
getQueries()
Get all the queries. |
XQuery |
getQuery(String qname)
Get an embedded query definition. |
Enumeration |
getQueryNames()
Get the names of embedded queries. |
int |
getStagedFlowCount()
Get staged parameter flows count. |
inetsoft.report.parameter.StagedParameterFlow[] |
getStagedParameterFlows()
Get staged parameter flows. |
int |
getStageLevel(int currentFlow)
Get currrent stage level. |
int |
getStageLevel(String element)
Get the stage level of a field element. |
inetsoft.util.IndexedStorage |
getStorage(AssetEntry entry)
Get the indexed storage of an asset entry. |
boolean |
hasMoreStages(int currentFlow)
Check if has more stages. |
boolean |
isEmbedded()
Check if it is an embeded parameter sheet. |
boolean |
isEnabledOnStage(ReportElement elem)
Check if a field element is enabled on current stage. |
boolean |
isPendingExecution(ReportElement elem)
Check if the query for element should be executed. |
boolean |
isValid()
Check if this parameter is valid. |
Enumeration |
nextStage(int currentFlow)
Switch to the next stage. |
void |
removeAllStagedFlows()
Remove all the StagedParameterFlows. |
void |
removeQuery(String qname)
Remove the named embedded query. |
void |
removeStagedFlow(int index)
Remove the StagedParameterFlow on the specified index. |
void |
resetStageLevel()
Reset current stage level for reuse. |
void |
setEmbedded(boolean embedded)
Set embeded property for the parameter sheet. |
void |
setExecutionSet(Set elems)
Set the set of elements to include in the next execution of the report. |
void |
setMainSheet(ReportSheet parent)
Set parent sheet. |
void |
setQuery(String qname,
XQuery query)
Add or remove an embedded query to the report. |
void |
setStageLevel(int currentFlow,
int slevel)
Set current stage level. |
void |
updateQuery(XQuery dx,
String oname)
Add or replace a query in the repository. |
| Methods inherited from class inetsoft.report.internal.StyleCore |
|---|
addChangeListener, addr, addScriptObject, advance, alignLine, append, append, calcGrid, checkDataSourceFolderPermission, checkDataSourcePermission, checkQueryFolderPermission, checkQueryPermission, cloneElements, cloneElements, complete, completeElement, copyQueries, copyStyleCore, createFinder, createFormatMap, createPresenterMap, deleteScriptEnv, fireEvent, format, format, getActionScriptable, getAllFooterElements, getAllHeaderElements, getBackgroundImageLocation, getBuildNumber, getBurstInfo, getCompositeElement, getDefaultFooter, getDefaultHeader, getDependencyFile, getDependencyFileName, getElementFooters, getElementHeaders, getElementWidth, getElemInfoBoundsMap, getElemInfoMap, getFinder, getFormat, getFormats, getFrames, getHeadingNumberArray, getHFTextFormatter, getLocalQueryRepository, getNextHeadingNumberArray, getNextID, getNumHeadingMap, getOnLoadResult, getOutputType, getPageTotalStart, getPagingLock, getParameterSheet, getParentScope, getPresenter, getProperties, getQueryManager, getReportManager, getReportMode, getScriptEnv, getScriptObject, getSecNumHeadingMap, getSheet, getTextSize, getTopReport, getVariableTable, hasOnPrint, isDesignTime, isLimited, isPrintMode, isReusePages, isRunTime, isSubreport, parseAssetRepository, printFixedContainer, printFixedContainer, processHF, processHF, putElemWarnings, removeChangeListener, renameQuery, renameQuery, resetCache, resetHeadingNumberArray, resetOnLoad, resetScriptEnv, restoreHeadingNumberArray, runOnInit, runOnLoad, runOnPrint, setBackgroundImageLocation, setBurstInfo, setDesignTime, setElemInfoBoundsMap, setFooterContinue, setHeaderContinue, setHeadingNumberArray, setHFTextFormatter, setHindent, setOverrideFooter, setOverrideHeader, setPageTotalStart, setParentScope, setPrintMode, setReportMode, setReportMode, setReusePages, setScriptEnv, setSubreport, setValue, setVariableTable, skip, toString, updateParameterSheet, writeAssetRepository |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final String STAGE_LEVEL
public static final String STAGE_FLOW_LEVEL
public static final String PARAMETER_SHEET
| Constructor Detail |
|---|
public ParameterSheet()
| Method Detail |
|---|
public inetsoft.report.parameter.StagedParameterFlow[] getStagedParameterFlows()
public void addStagedParameterFlow(inetsoft.report.parameter.StagedParameterFlow sflow)
sflow - the specified staged parameter flow.
public void addStagedParameterFlow(int index,
inetsoft.report.parameter.StagedParameterFlow sflow)
index - the specified index.sflow - the specified staged parameter flow.public int getStagedFlowCount()
public void removeAllStagedFlows()
public void removeStagedFlow(int index)
index - the specified index.public void resetStageLevel()
public void setStageLevel(int currentFlow,
int slevel)
public int getStageLevel(int currentFlow)
public int getCurrentStagedFlow(String elem)
elem - the specified element name.
public boolean hasMoreStages(int currentFlow)
currentFlow - the specified staged flow number.
public Enumeration nextStage(int currentFlow)
currentFlow - the specified staged flow number.
public int getStageLevel(String element)
element - form.name format of the specified field element.
public void setExecutionSet(Set elems)
public boolean isPendingExecution(ReportElement elem)
public boolean isEnabledOnStage(ReportElement elem)
elem - the specified element.
public boolean isEmbedded()
public void setEmbedded(boolean embedded)
public boolean isValid()
public void setMainSheet(ReportSheet parent)
public Enumeration getQueryNames()
getQueryNames in class ReportSheetpublic XQuery getQuery(String qname)
getQuery in interface XQueryRepositorygetQuery in class ReportSheetqname - the specified query name.
public Enumeration getQueries()
getQueries in interface XQueryRepositorygetQueries in class ReportSheet
public void setQuery(String qname,
XQuery query)
setQuery in class ReportSheet
public void updateQuery(XQuery dx,
String oname)
throws Exception
updateQuery in interface XQueryRepositoryupdateQuery in class ReportSheetdx - new query.oname - old name of the query, if the name has been changed.
Otherwise it should be null.
Exceptionpublic void removeQuery(String qname)
removeQuery in interface XQueryRepositoryremoveQuery in class ReportSheet
public inetsoft.util.IndexedStorage getStorage(AssetEntry entry)
throws Exception
getStorage in interface AssetRepositorygetStorage in class AbstractAssetEngineentry - the specified asset entry.
Exceptionpublic Object clone()
ReportSheet
clone in class TabularSheet
|
Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved. | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||