WebDrillDown for JSP
Public Member Functions | Static Public Member Functions | List of all members
Coalesys.WebDrillDown.WebDrillDown Class Reference

WebDrillDown class. More...

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

Public Member Functions

Item addItem ()
 Adds a new item to the items collection. More...
 
Item addItem (String text)
 Adds a new item to the items collection. More...
 
Item addItem (String text, String hint)
 Adds a new item to the items collection. More...
 
Button getButton ()
 Gets the button style object. More...
 
String getFullPath ()
 Gets the current full path selected in the webdrilldown control. More...
 
int getHideTimer ()
 Gets the hide timer for the webdrilldown popups (in milliseconds, zero to disable). More...
 
ArrayList< ItemgetItems ()
 Gets the items collection. More...
 
Popup getPopup ()
 Gets the popup style object. More...
 
int getSelectedIndex ()
 Gets the index of the selected button in the webdrilldown control. More...
 
int getShowTimer ()
 Gets the show timer for the webdrilldown popups (in milliseconds, zero to disable). More...
 
void setFullPath (String value)
 Sets the current full path selected in the webdrilldown control. More...
 
void setHideTimer (int value)
 Sets the hide timer for the webdrilldown popups (in milliseconds, zero to disable). More...
 
void setSelectedIndex (int value)
 Sets the index of the selected button in the webdrilldown control. More...
 
void setShowTimer (int value)
 Sets the show timer for the webdrilldown popups (in milliseconds, zero to disable). More...
 
 WebDrillDown ()
 WebDrillDown constructor. More...
 
 WebDrillDown (String id)
 WebDrillDown constructor. More...
 
 WebDrillDown (String id, Map< String, String[]> parameterMap)
 WebDrillDown constructor. More...
 
- Public Member Functions inherited from Coalesys.WebDrillDown.WebControl
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...
 

Static Public Member Functions

static String appendKeyValue (String sourcePath, String keyString, String valueString)
 Appends a new key/value pair to the end of the path string. More...
 
static String extractKeys (String sourcePath)
 Extracts the key portion(s) of a string that contains key/value pair(s). More...
 
static String extractValues (String sourcePath)
 Extracts the value portion(s) of a string that contains key/value pair(s). More...
 

Detailed Description

WebDrillDown class.

Constructor & Destructor Documentation

Coalesys.WebDrillDown.WebDrillDown.WebDrillDown ( )
inline

WebDrillDown constructor.

Coalesys.WebDrillDown.WebDrillDown.WebDrillDown ( String  id)
inline

WebDrillDown constructor.

Parameters
idThe control identifier.
Coalesys.WebDrillDown.WebDrillDown.WebDrillDown ( String  id,
Map< String, String[]>  parameterMap 
)
inline

WebDrillDown constructor.

Parameters
idThe control identifier.
parameterMapThe request parameter map.

Member Function Documentation

Item Coalesys.WebDrillDown.WebDrillDown.addItem ( )
inline

Adds a new item to the items collection.

Returns
The item object.
Item Coalesys.WebDrillDown.WebDrillDown.addItem ( String  text)
inline

Adds a new item to the items collection.

Parameters
textThe text string displayed for the item.
Returns
The item object.
Item Coalesys.WebDrillDown.WebDrillDown.addItem ( String  text,
String  hint 
)
inline

Adds a new item to the items collection.

Parameters
textThe text string displayed for the item.
hintThe user-defined hint for applying custom styles.
Returns
The item object.
static String Coalesys.WebDrillDown.WebDrillDown.appendKeyValue ( String  sourcePath,
String  keyString,
String  valueString 
)
inlinestatic

Appends a new key/value pair to the end of the path string.

Parameters
sourcePathThe source path to append the new key/value pair.
keyStringThe new key string to append to the end of the path.
valueStringThe new value string to append to the end of the path.
Returns
The resulting path that contains the new key/value pair.
static String Coalesys.WebDrillDown.WebDrillDown.extractKeys ( String  sourcePath)
inlinestatic

Extracts the key portion(s) of a string that contains key/value pair(s).

Parameters
sourcePathThe source path that contains some key/value pair(s).
Returns
The resulting path that contains key(s) only.
static String Coalesys.WebDrillDown.WebDrillDown.extractValues ( String  sourcePath)
inlinestatic

Extracts the value portion(s) of a string that contains key/value pair(s).

Parameters
sourcePathThe source path that contains some key/value pair(s).
Returns
The resulting path that contains value(s) only.
Button Coalesys.WebDrillDown.WebDrillDown.getButton ( )
inline

Gets the button style object.

String Coalesys.WebDrillDown.WebDrillDown.getFullPath ( )
inline

Gets the current full path selected in the webdrilldown control.

int Coalesys.WebDrillDown.WebDrillDown.getHideTimer ( )
inline

Gets the hide timer for the webdrilldown popups (in milliseconds, zero to disable).

ArrayList<Item> Coalesys.WebDrillDown.WebDrillDown.getItems ( )
inline

Gets the items collection.

Popup Coalesys.WebDrillDown.WebDrillDown.getPopup ( )
inline

Gets the popup style object.

int Coalesys.WebDrillDown.WebDrillDown.getSelectedIndex ( )
inline

Gets the index of the selected button in the webdrilldown control.

int Coalesys.WebDrillDown.WebDrillDown.getShowTimer ( )
inline

Gets the show timer for the webdrilldown popups (in milliseconds, zero to disable).

void Coalesys.WebDrillDown.WebDrillDown.setFullPath ( String  value)
inline

Sets the current full path selected in the webdrilldown control.

void Coalesys.WebDrillDown.WebDrillDown.setHideTimer ( int  value)
inline

Sets the hide timer for the webdrilldown popups (in milliseconds, zero to disable).

void Coalesys.WebDrillDown.WebDrillDown.setSelectedIndex ( int  value)
inline

Sets the index of the selected button in the webdrilldown control.

void Coalesys.WebDrillDown.WebDrillDown.setShowTimer ( int  value)
inline

Sets the show timer for the webdrilldown popups (in milliseconds, zero to disable).


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