|
SilverStream Application Server 3.5 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.sssw.shr.page.AgpTag | +--com.sssw.shr.page.AgpControlBase | +--com.sssw.shr.page.AgpBlock | +--com.sssw.shr.page.AgpContainer | +--com.sssw.shr.page.AgpViewPanel
AgpViewPanel is a type of AgpContainer that represents a tabular data view. It consists of two blocks:
Fields inherited from class com.sssw.shr.page.AgpTag |
UNIT_PERCENT,
UNIT_PIXEL |
Constructor Summary | |
AgpViewPanel()
|
Method Summary | |
AgiRowCursor |
getCurrentRowCursor()
Returns a row cursor pointing to the current row. |
boolean |
getEnableScrolling()
Returns a boolean indicating whether scrolling is enabled. |
boolean |
getLimitRowCount()
Returns a boolean indicating whether the number of rows displayed on a page is limited to the Rows property. |
int |
getOverlapRowCount()
Returns the number of rows to overlap when scrolling up and down. |
int |
getPageRowCount()
Returns the number of rows to display at one time. |
AgiRowCursor |
getRootRowCursor()
Returns a row cursor to allow navigating the data independently of the view. |
Serializable |
invokeQuery(Serializable param)
If the view is loading data from a Data Source Object, you must use this method to invoke it and populate the view with the resulting data. |
boolean |
scrollDownPage()
Scrolls to the next page. |
boolean |
scrollDownRow()
Scrolls the view down by one row. |
boolean |
scrollToFirstRow()
Scrolls the view to the top row of data. |
boolean |
scrollToLastRow()
Scrolls the view so that the last row of data is visible. |
boolean |
scrollUpPage()
Scrolls to the previous page. |
boolean |
scrollUpRow()
Scrolls the view up by one row. |
void |
setDataProvider(AgiRowCursor provider)
Sets a different data source for the view to scroll. |
void |
setDataSource(String dsoName)
Specify the Data Source object from which this view should load its data. |
void |
setEnableScrolling(boolean scrolling)
Sets whether scrolling is enabled. |
void |
setLimitRowCount(boolean limitrowcount)
Sets whether the number of rows displayed per page should be limited. |
void |
setOverlapRowCount(int rowcount)
Specifies the number of rows to overlap when scrolling up and down by page. |
void |
setPageRowCount(int rowcount)
Sets the number of rows to display in the view on a page. |
Methods inherited from class com.sssw.shr.page.AgpContainer |
getBlock,
getBlockCount,
getGroup,
getGroupCount |
Methods inherited from class com.sssw.shr.page.AgpBlock |
getControls |
Methods inherited from class com.sssw.shr.page.AgpControlBase |
getName |
Methods inherited from class com.sssw.shr.page.AgpTag |
getBoolProperty,
getEnableHTMLGeneration,
getIntArrayProperty,
getIntProperty,
getIntPropertyUnit,
getProperty,
getStringArrayProperty,
invalidateHTML,
removeProperty,
setEnableHTMLGeneration,
setIntProperty,
setProperty |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Methods implemented from interface com.sssw.shr.page.AgiJavaScriptEnhanced |
generateFunction,
generateRepaintScript,
generateScriptInitializers,
getFunctionNameForMethod,
getFunctionNames,
getMethodNames,
getScriptObjectName,
isHTMLRepaintPending,
isJavaScriptRepaintPending |
Methods implemented from interface com.sssw.shr.page.AgiPageControl |
generateHTML,
getPrefix,
notifyPageLoaded,
notifyPageRequestBegin,
notifyPageRequestEnd,
notifyPostValue,
notifyPostValues |
Methods implemented from interface com.sssw.shr.page.AgiPageSubmitProcessor |
notifySubmit |
Methods implemented from interface com.sssw.rt.event.AgiRowSetListener |
dataReceivedAsync,
dataReloaded,
rowDataChanged,
rowDeleted,
rowInserted,
rowPreDelete,
rowPreInsert |
Methods implemented from interface com.sssw.rt.util.AgiRowSetManager |
clearRows,
haveRowsChanged,
query,
query,
refreshRows,
updateRows |
Methods implemented from interface java.io.Externalizable |
readExternal,
writeExternal |
Methods implemented from interface javax.servlet.Servlet |
destroy,
getServletConfig,
getServletInfo,
init,
service |
Constructor Detail |
public AgpViewPanel()
Method Detail |
public int getPageRowCount()
This property is used only if the Limit Rows Per Page property is set to true.
int rowPerPage = agpView1.getPageRowCount();
AgpViewPanel.setPageRowCount(int rowcount)
public void setPageRowCount(int rowcount)
rowcount
- the number of rows.In order for this property to take effect, the Limit Rows Per Page property should be set to true.
agpView1.setPageRowCount(10);
AgpViewPanel.getPageRowCount()
public int getOverlapRowCount()
int overlapRows = agpView1.getOverlapRowCount();
AgpViewPanel.setOverlapRowCount(int rowcount)
public void setOverlapRowCount(int rowcount)
rowcount
- the number of rows to overlap.agpView1.setOverlapRowCount(2);
AgpViewPanel.getOverlapRowCount()
public boolean getLimitRowCount()
boolean limitRows = agpView1.getLimitRowCount();
AgpViewPanel.setLimitRowCount(boolean limitrowcount)
public void setLimitRowCount(boolean limitrowcount)
limitrowcount
- true
if the number should be limited,
or false
to leave the number unlimited.
Use the setLimitRowCount
method to set the number of
rows displayed on a page.
agpView1.setLimitRowCount(true);
AgpViewPanel.getLimitRowCount()
public boolean getEnableScrolling()
boolean scrolling = agpView1.getEnableScrolling();
AgpViewPanel.setEnableScrolling(boolean scrolling)
public void setEnableScrolling(boolean scrolling)
scrolling
- true
if scrolling
should be enabled, false
if not.agpView1.setEnableScrolling(true);
AgpViewPanel.getEnableScrolling()
public AgiRowCursor getRootRowCursor()
The row cursor is positioned arbitrarily within the view data.
The programmer must call gotoFirst()
to position
it on the first row.
AgiRowCursor rc = agpView1.getRootRowCursor();
public AgiRowCursor getCurrentRowCursor()
This method is only valid while processing an event from a control contained in a data row of the view, for example, a property change event from a checkbox or a link event from a label.
AgiRowCursor rc = agpView1.getCurrentRowCursor();
public void setDataProvider(AgiRowCursor provider) throws AgoSecurityException, AgoTransientSystemException, AgoUnrecoverableSystemException
provider
- the alternate data source object.Normally an HTML view scrolls only its built-in data source. Use this method to specify a different data source. If calling this method, expressions in the view must refer only to fields within the specified data source. Note that an HTML View uses the actual object provided in this call. Programmatically scrolling this object outside the view will affect the view's behavior and is not recommended.
agpView1.setDataProvider(agpData3);
public void setDataSource(String dsoName)
public Serializable invokeQuery(Serializable param) throws Exception
Invalid if setDataProvider() has been called.
public boolean scrollToFirstRow() throws AgoSecurityException, AgoTransientSystemException, AgoUnrecoverableSystemException
Because the view remembers its top row of data, the programmer may need to call this method if new data has been inserted in order for the new data to display.
agpView1.scrollToFirstRow();
AgpViewPanel.scrollDownPage()
,
AgpViewPanel.scrollDownRow()
,
AgpViewPanel.scrollToLastRow()
,
AgpViewPanel.scrollUpPage()
,
AgpViewPanel.scrollUpRow()
public boolean scrollToLastRow() throws AgoSecurityException, AgoTransientSystemException, AgoUnrecoverableSystemException
The view attempts to position the last row of data at the bottom of its allowed set of visible rows, to display a full page of data.
agpView1.scrollToLastRow();
AgpViewPanel.scrollDownPage()
,
AgpViewPanel.scrollDownRow()
,
AgpViewPanel.scrollToFirstRow()
,
AgpViewPanel.scrollUpPage()
,
AgpViewPanel.scrollUpRow()
public boolean scrollDownRow() throws AgoSecurityException, AgoTransientSystemException, AgoUnrecoverableSystemException
agpView1.scrollDownRow();
AgpViewPanel.scrollDownPage()
,
AgpViewPanel.scrollToFirstRow()
,
AgpViewPanel.scrollToLastRow()
,
AgpViewPanel.scrollUpPage()
,
AgpViewPanel.scrollUpRow()
public boolean scrollUpRow() throws AgoSecurityException, AgoTransientSystemException, AgoUnrecoverableSystemException
agpView1.scrollUpRow();
AgpViewPanel.scrollDownPage()
,
AgpViewPanel.scrollDownRow()
,
AgpViewPanel.scrollToFirstRow()
,
AgpViewPanel.scrollToLastRow()
,
AgpViewPanel.scrollUpPage()
public boolean scrollUpPage() throws AgoSecurityException, AgoTransientSystemException, AgoUnrecoverableSystemException
This method is useful only if the view is limited in the number of
rows it displays at one time. The view displays the previous page of
data, unless it has reached the first row of available data. The data
on the new page includes some rows from the previously displayed page if the
number of overlap rows (setOverlapRowCount()
) is greater than zero.
agpView1.scrollUpPage();
AgpViewPanel.scrollDownPage()
,
AgpViewPanel.scrollDownRow()
,
AgpViewPanel.scrollToFirstRow()
,
AgpViewPanel.scrollToLastRow()
,
AgpViewPanel.scrollUpRow()
public boolean scrollDownPage() throws AgoSecurityException, AgoTransientSystemException, AgoUnrecoverableSystemException
This method is useful only if the view is limited in the number of
rows it displays at one time. The view displays the next page of
data, unless it has reached the last row of available data. The data
on the new page includes some rows from the previous page if the
number of overlap rows (setOverlapRowCount()
) is greater than zero.
agpView1.scrollDownPage();
AgpViewPanel.setLimitRowCount(boolean limitrowcount)
,
AgpViewPanel.setOverlapRowCount(int rowcount)
,
AgpViewPanel.scrollDownRow()
,
AgpViewPanel.scrollToFirstRow()
,
AgpViewPanel.scrollToLastRow()
,
AgpViewPanel.scrollUpPage()
,
AgpViewPanel.scrollUpRow()
|
SilverStream Application Server 3.5 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |