oracle.dss.thin.beans.dataView
Class PagingControl

java.lang.Object
  |
  +--oracle.dss.thin.beans.dataView.PagingControl

All Implemented Interfaces:

Styleable, ViewComponent

public class PagingControl

extends java.lang.Object

implements ViewComponent, Styleable

The paging control for the thin presentation.

Method Summary

java.lang.String	getComponentName() Retrieves the name of the paging control.
int	getID() Retrieves the ID for the paging control.
ViewStyle	getViewStyle() Retrieves the ViewStyle that specifies the format of the items in the paging control.
int	getWidth() Retrieves the number of page items that appear on a line.
boolean	isAutosubmit() Indicates whether changes in this PagingControl are automatically submitted to the data source.
boolean	isEnabled() Indicates whether this PagingControl is enabled.
boolean	isVisible() Indicates whether this PagingControl is visible.
void	setAutosubmit(boolean autosubmit) Specifies whether changes in this PagingControl are automatically submitted to the data source.
void	setEnabled(boolean enabled) Specifies whether this PagingControl is enabled.
void	setViewStyle(ViewStyle vs) Specifies the ViewStyle that specifies the format of the items in the paging control.
void	setVisible(boolean visible) Specifies whether this PagingControl is visible.
void	setWidth(int width) Specifies the number of page items to display in a line.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface oracle.dss.dataView.ViewComponent

getBeanInfo

Method Detail

getID

public int getID()

Retrieves the ID for the paging control.

Specified by:

getID in interface ViewComponent

Returns:

The ID for the paging control.

getComponentName

public java.lang.String getComponentName()

Retrieves the name of the paging control.

Specified by:

getComponentName in interface ViewComponent

Returns:

The name of the paging control.

getViewStyle

public ViewStyle getViewStyle()

Retrieves the ViewStyle that specifies the format of the items in the paging control.

Note: Before you apply oracle.dss.dataView.CSSStyleDefaults to the view, the ViewStyle that this method returns does not have the default values that the paging control actually uses. The paging control gets its values from the cascading style sheet. The only ViewStyle properties that the paging control uses are those that have been explicitly set. To find whether a property has been explicitly set, call the isPropertyUsed method. For example, if isBackgroundUsed returns true, then the Background property has been explicitly set, and the paging control will use the Background value over the value in the CSS file.

Specified by:

getViewStyle in interface Styleable

Returns:

The ViewStyle that specifies formatting for the page items.

See Also:

ThinGridView.applyCSSStyleDefaults(oracle.dss.dataView.CSSStyleDefaults)

setViewStyle

public void setViewStyle(ViewStyle vs)

Specifies the ViewStyle that specifies the format of the items in the paging control.

Specified by:

setViewStyle in interface Styleable

Parameters:

vs - The ViewStyle to use for formatting the page items.

setEnabled

public void setEnabled(boolean enabled)

Specifies whether this PagingControl is enabled. When a PagingControl is disabled, it is visible, but users cannot operate on the PagingControl.

Parameters:

enabled - true to enable this PagingControl, false to disable it.

isEnabled

public boolean isEnabled()

Indicates whether this PagingControl is enabled. When a PagingControl is disabled, it is visible, but users cannot operate on the PagingControl.

Returns:

true if the PagingControl is enabled, false if the PagingControl is disabled.

setVisible

public void setVisible(boolean visible)

Specifies whether this PagingControl is visible. If you make this PagingControl visible, then you must also define a Find Member dialog and connect it to the thin presentation that goes with this paging control.

Parameters:

visible - true to display this PagingControl, false to not display it.

See Also:

FindMember

isVisible

public boolean isVisible()

Indicates whether this PagingControl is visible.

Returns:

true if the PagingControl is visible, false if the PagingControl is visible.

setAutosubmit

public void setAutosubmit(boolean autosubmit)

Specifies whether changes in this PagingControl are automatically submitted to the data source. By default, Autosubmit is false.

Parameters:

autosubmit - true to enable automatic submission of changes, false to disable automatic submission.

isAutosubmit

public boolean isAutosubmit()

Indicates whether changes in this PagingControl are automatically submitted to the data source.

Returns:

true if automatic submission is enabled, false if it is not.

setWidth

public void setWidth(int width)

Specifies the number of page items to display in a line. If this PagingControl has more page items than the value that you specify in this method, then the extra page items appear on a new line. By default, this property is set to 3.

Parameters:

width - The number of page items to display in a line. To display all page items on the same line, pass 0.

getWidth

public int getWidth()

Retrieves the number of page items that appear on a line. If this PagingControl displays more page items than the value that this method returns, then the extra page items wrap to a new line.

Returns:

The number of page items that appear on a single line.