WebDrillDown for JSP
Public Member Functions | List of all members
Coalesys.WebDrillDown.WebControl Class Referenceabstract

WebControl class. More...

Inheritance diagram for Coalesys.WebDrillDown.WebControl:
Coalesys.WebDrillDown.WebDrillDown

Public Member Functions

String getAbout ()
 Returns about information for the control. More...
 
String getAccessKey ()
 Gets the access key that allows you to quickly navigate to the control. More...
 
String getBackColor ()
 Gets the background color of the control. More...
 
String getBorderColor ()
 Gets the border color of the control. More...
 
BorderStyle getBorderStyle ()
 Gets the border color of the control. More...
 
String getBorderWidth ()
 Gets the border width of the control. More...
 
String getControlData ()
 Gets the item data to display in the control. More...
 
String getCustomClassPrefix ()
 Gets the prefix string to use for custom css class names. More...
 
String getDataRetrievalUrl ()
 Gets the location to retrieve item data. More...
 
boolean getEnabled ()
 Gets a value indicating whether the control is enabled. More...
 
boolean getEnableOutline ()
 Gets whether to enable outline for keyboard focus. More...
 
FontInfo getFont ()
 Gets the font properties associated with the control. More...
 
String getForeColor ()
 Gets the text color for the control. More...
 
String getHeight ()
 Gets the height of the control. More...
 
String getID ()
 Gets the programmatic identifier assigned to the control. More...
 
String getName ()
 Gets the name of the control. More...
 
int getRetentionPeriod ()
 Gets the number of seconds before the item data is discarded (zero or less for infinite). More...
 
int getTabIndex ()
 Gets the tab order of the control. More...
 
String getToolTip ()
 Gets the tooltip displayed when the mouse is over the control. More...
 
String getUserData ()
 Gets the user data for the control. More...
 
String getWidth ()
 Gets the width of the control. More...
 
void loadState (String file) throws Exception
 Loads the control state from the specified file. More...
 
void loadState (InputStream stream) throws Exception
 Loads the control state from the specified stream. More...
 
String renderControl ()
 Renders the required code for this control instance. More...
 
void saveState (String file) throws Exception
 Saves the control state to the specified file. More...
 
void saveState (OutputStream stream) throws Exception
 Saves the control state to the specified stream. More...
 
void setAccessKey (String value)
 Sets the access key that allows you to quickly navigate to the control. More...
 
void setBackColor (String value)
 Sets the background color of the control. More...
 
void setBorderColor (String value)
 Sets the border color of the control. More...
 
void setBorderStyle (BorderStyle value)
 Sets the border color of the control. More...
 
void setBorderWidth (String value)
 Sets the border width of the control. More...
 
void setControlData (String value)
 Sets the item data to display in the control. More...
 
void setCustomClassPrefix (String value)
 Sets the prefix string to use for custom css class names. More...
 
void setDataRetrievalUrl (String value)
 Sets the location to retrieve item data. More...
 
void setEnabled (boolean value)
 Sets a value indicating whether the control is enabled. More...
 
void setEnableOutline (boolean value)
 Sets whether to enable outline for keyboard focus. More...
 
void setForeColor (String value)
 Sets the text color for the control. More...
 
void setHeight (String value)
 Sets the height of the control. More...
 
void setID (String value)
 Sets the programmatic identifier assigned to the control. More...
 
void setName (String value)
 Sets the name of the control. More...
 
void setRetentionPeriod (int value)
 Sets the number of seconds before the item data is discarded (zero or less for infinite). More...
 
void setTabIndex (int value)
 Sets the tab order of the control. More...
 
void setToolTip (String value)
 Sets the tooltip displayed when the mouse is over the control. More...
 
void setUserData (String value)
 Sets the user data for the control. More...
 
void setWidth (String value)
 Sets the width of the control. More...
 

Detailed Description

WebControl class.

Member Function Documentation

String Coalesys.WebDrillDown.WebControl.getAbout ( )
inline

Returns about information for the control.

String Coalesys.WebDrillDown.WebControl.getAccessKey ( )
inline

Gets the access key that allows you to quickly navigate to the control.

String Coalesys.WebDrillDown.WebControl.getBackColor ( )
inline

Gets the background color of the control.

String Coalesys.WebDrillDown.WebControl.getBorderColor ( )
inline

Gets the border color of the control.

BorderStyle Coalesys.WebDrillDown.WebControl.getBorderStyle ( )
inline

Gets the border color of the control.

String Coalesys.WebDrillDown.WebControl.getBorderWidth ( )
inline

Gets the border width of the control.

String Coalesys.WebDrillDown.WebControl.getControlData ( )
inline

Gets the item data to display in the control.

String Coalesys.WebDrillDown.WebControl.getCustomClassPrefix ( )
inline

Gets the prefix string to use for custom css class names.

String Coalesys.WebDrillDown.WebControl.getDataRetrievalUrl ( )
inline

Gets the location to retrieve item data.

boolean Coalesys.WebDrillDown.WebControl.getEnabled ( )
inline

Gets a value indicating whether the control is enabled.

boolean Coalesys.WebDrillDown.WebControl.getEnableOutline ( )
inline

Gets whether to enable outline for keyboard focus.

FontInfo Coalesys.WebDrillDown.WebControl.getFont ( )
inline

Gets the font properties associated with the control.

String Coalesys.WebDrillDown.WebControl.getForeColor ( )
inline

Gets the text color for the control.

String Coalesys.WebDrillDown.WebControl.getHeight ( )
inline

Gets the height of the control.

String Coalesys.WebDrillDown.WebControl.getID ( )
inline

Gets the programmatic identifier assigned to the control.

String Coalesys.WebDrillDown.WebControl.getName ( )
inline

Gets the name of the control.

int Coalesys.WebDrillDown.WebControl.getRetentionPeriod ( )
inline

Gets the number of seconds before the item data is discarded (zero or less for infinite).

int Coalesys.WebDrillDown.WebControl.getTabIndex ( )
inline

Gets the tab order of the control.

String Coalesys.WebDrillDown.WebControl.getToolTip ( )
inline

Gets the tooltip displayed when the mouse is over the control.

String Coalesys.WebDrillDown.WebControl.getUserData ( )
inline

Gets the user data for the control.

String Coalesys.WebDrillDown.WebControl.getWidth ( )
inline

Gets the width of the control.

void Coalesys.WebDrillDown.WebControl.loadState ( String  file) throws Exception
inline

Loads the control state from the specified file.

Parameters
fileThe source file name.
void Coalesys.WebDrillDown.WebControl.loadState ( InputStream  stream) throws Exception
inline

Loads the control state from the specified stream.

Parameters
streamThe source stream object.
String Coalesys.WebDrillDown.WebControl.renderControl ( )
inline

Renders the required code for this control instance.

Returns
The control generated code.
void Coalesys.WebDrillDown.WebControl.saveState ( String  file) throws Exception
inline

Saves the control state to the specified file.

Parameters
fileThe destination file name.
void Coalesys.WebDrillDown.WebControl.saveState ( OutputStream  stream) throws Exception
inline

Saves the control state to the specified stream.

Parameters
streamThe destination stream object.
void Coalesys.WebDrillDown.WebControl.setAccessKey ( String  value)
inline

Sets the access key that allows you to quickly navigate to the control.

void Coalesys.WebDrillDown.WebControl.setBackColor ( String  value)
inline

Sets the background color of the control.

void Coalesys.WebDrillDown.WebControl.setBorderColor ( String  value)
inline

Sets the border color of the control.

void Coalesys.WebDrillDown.WebControl.setBorderStyle ( BorderStyle  value)
inline

Sets the border color of the control.

void Coalesys.WebDrillDown.WebControl.setBorderWidth ( String  value)
inline

Sets the border width of the control.

void Coalesys.WebDrillDown.WebControl.setControlData ( String  value)
inline

Sets the item data to display in the control.

void Coalesys.WebDrillDown.WebControl.setCustomClassPrefix ( String  value)
inline

Sets the prefix string to use for custom css class names.

void Coalesys.WebDrillDown.WebControl.setDataRetrievalUrl ( String  value)
inline

Sets the location to retrieve item data.

void Coalesys.WebDrillDown.WebControl.setEnabled ( boolean  value)
inline

Sets a value indicating whether the control is enabled.

void Coalesys.WebDrillDown.WebControl.setEnableOutline ( boolean  value)
inline

Sets whether to enable outline for keyboard focus.

void Coalesys.WebDrillDown.WebControl.setForeColor ( String  value)
inline

Sets the text color for the control.

void Coalesys.WebDrillDown.WebControl.setHeight ( String  value)
inline

Sets the height of the control.

void Coalesys.WebDrillDown.WebControl.setID ( String  value)
inline

Sets the programmatic identifier assigned to the control.

void Coalesys.WebDrillDown.WebControl.setName ( String  value)
inline

Sets the name of the control.

void Coalesys.WebDrillDown.WebControl.setRetentionPeriod ( int  value)
inline

Sets the number of seconds before the item data is discarded (zero or less for infinite).

void Coalesys.WebDrillDown.WebControl.setTabIndex ( int  value)
inline

Sets the tab order of the control.

void Coalesys.WebDrillDown.WebControl.setToolTip ( String  value)
inline

Sets the tooltip displayed when the mouse is over the control.

void Coalesys.WebDrillDown.WebControl.setUserData ( String  value)
inline

Sets the user data for the control.

void Coalesys.WebDrillDown.WebControl.setWidth ( String  value)
inline

Sets the width of the control.


The documentation for this class was generated from the following file: