com.plumtree.portalpages.common.search
Class DynamicQueryTable

java.lang.Object
  com.plumtree.portalpages.common.search.DynamicQueryTable

All Implemented Interfaces:

IFilterQueryTable

public class DynamicQueryTable
extends java.lang.Object
implements IFilterQueryTable

Author:

sample This class generates html necessary to construct a table containing DIVs of table rows that are revealed and hidden from the last visible row of the table. A total of five calls will generate all of the necessary elements: 1) SetBlankQueryCondition(QueryCondition) // defines the row template 2) generateTable (numberOfRows) // gets a table of hidden rows 3) getJavaScriptFunctions() // gets necessary script elements 4) getAddConditionButton(strAdd) // button to reveal a row 5) getRemoveLastConditionButton(strRemove) // button to hide last row The "Add Condition" and "Remove Last Condition" buttons must be retrieved with separate calls.

Constructor Summary

DynamicQueryTable(java.lang.String strName, int Depth, AActivitySpace owner)
Creates a new DynamicQueryTable object.

Method Summary

static void	AddGlobalElements(java.lang.String strActiveClause, int groupCount, HTMLElementCollection result)
static void	AddGlobalElements(java.lang.String prefix, java.lang.String strActiveClause, int groupCount, HTMLElementCollection result)
void	addTableToCollection(HTMLElementCollection result, boolean showErrorsNextToInputs, JSDateTimePickerMgr jsDateTimePickerMgr, PageMgr _ptPageMgr)
void	addTableToCollection(java.lang.String prefix, HTMLElementCollection result, boolean showErrorsNextToInputs, JSDateTimePickerMgr jsDateTimePickerMgr, PageMgr _ptPageMgr, boolean jitDatePicker)
static void	AddTopLevelSearchBoxAndOperator(java.lang.String searchstring, boolean AllMustPass, boolean useVerboseTerminology, HTMLElement textboxLabel, HTMLElementCollection result, java.lang.String strLang)
static void	AddTopLevelSearchBoxAndOperator(java.lang.String searchstring, boolean AllMustPass, HTMLElementCollection result, java.lang.String strLang)
static HTMLElement	GetAddConditionButton(java.lang.String strLabel, java.lang.String strLang, AActivitySpace owner) Returns an action bar style "button" (Anchor with attached image and text) for adding a search filter condition
static HTMLElement	GetAddNewClauseButton(java.lang.String strLabel, java.lang.String strLang, AActivitySpace owner) Returns an action bar style "button" (Anchor with attached image and text) for adding a search filter clause
boolean	GetAllMustPass()
QueryCondition	GetDefinedQueryCondition(int iIndex)
static HTMLElement	GetJavaScript(java.lang.String submitString, AActivitySpace asOwner) Returns JavaScript necessary for the Dynamic Query Table to work.
static HTMLElement	GetJavaScript(java.lang.String uniqueID, java.lang.String submitString, AActivitySpace asOwner) Returns JavaScript necessary for the Dynamic Query Table to work.
static HTMLElement	GetRemoveClauseButton(java.lang.String strLabel, java.lang.String strLang, AActivitySpace owner) Returns an action bar style "button" (Anchor with attached image and text) for removing a search filter clause
static HTMLElement	GetRemoveLastConditionButton(java.lang.String strLabel, java.lang.String strLang, AActivitySpace owner) Returns an action bar style "button" (Anchor with attached image and text) for removing the last search filter condition
static HTMLElement	GetTestButton(java.lang.String label, java.lang.String script, AActivitySpace space)
void	loadDefinedQueryCondition(QueryCondition qc)
void	removeDefinedQueryCondition(int iIndex)
void	SetAllMustPass(boolean bOperator)
void	SetBlankQueryCondition(QueryCondition qc)
void	SetExtraRowBelowGroupHeader(HTMLElement e)
void	SetExtraRowBelowGroupHeader(java.lang.String s)
void	SetHideGroupHeaderRow(boolean hide)
void	SetLabel(java.lang.String label)
void	SetSuppressCheckbox(boolean b)
void	SetTableSize(int nRows)
void	SetUseVerboseTerminology(boolean b)

Methods inherited from class java.lang.Object

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

Constructor Detail

DynamicQueryTable

public DynamicQueryTable(java.lang.String strName,
                         int Depth,
                         AActivitySpace owner)

Creates a new DynamicQueryTable object.

Parameters:

strName -

Depth -

owner -

Method Detail

SetAllMustPass

public void SetAllMustPass(boolean bOperator)

Specified by:

SetAllMustPass in interface IFilterQueryTable

Parameters:

bOperator -

SetBlankQueryCondition

public void SetBlankQueryCondition(QueryCondition qc)

Specified by:

SetBlankQueryCondition in interface IFilterQueryTable

Parameters:

qc -

SetExtraRowBelowGroupHeader

public void SetExtraRowBelowGroupHeader(java.lang.String s)

Specified by:

SetExtraRowBelowGroupHeader in interface IFilterQueryTable

Parameters:

s -

SetExtraRowBelowGroupHeader

public void SetExtraRowBelowGroupHeader(HTMLElement e)

Specified by:

SetExtraRowBelowGroupHeader in interface IFilterQueryTable

Parameters:

s -

SetHideGroupHeaderRow

public void SetHideGroupHeaderRow(boolean hide)

Specified by:

SetHideGroupHeaderRow in interface IFilterQueryTable

SetLabel

public void SetLabel(java.lang.String label)

Specified by:

SetLabel in interface IFilterQueryTable

Parameters:

label -

SetSuppressCheckbox

public void SetSuppressCheckbox(boolean b)

Specified by:

SetSuppressCheckbox in interface IFilterQueryTable

Parameters:

b -

SetTableSize

public void SetTableSize(int nRows)

Specified by:

SetTableSize in interface IFilterQueryTable

Parameters:

nRows -

SetUseVerboseTerminology

public void SetUseVerboseTerminology(boolean b)

Specified by:

SetUseVerboseTerminology in interface IFilterQueryTable

Parameters:

b -

AddGlobalElements

public static void AddGlobalElements(java.lang.String strActiveClause,
                                     int groupCount,
                                     HTMLElementCollection result)

Parameters:

strActiveClause -

groupCount -

result -

Throws:

java.lang.Exception

AddGlobalElements

public static void AddGlobalElements(java.lang.String prefix,
                                     java.lang.String strActiveClause,
                                     int groupCount,
                                     HTMLElementCollection result)

Parameters:

strActiveClause -

groupCount -

result -

Throws:

java.lang.Exception

AddTopLevelSearchBoxAndOperator

public static void AddTopLevelSearchBoxAndOperator(java.lang.String searchstring,
                                                   boolean AllMustPass,
                                                   HTMLElementCollection result,
                                                   java.lang.String strLang)

Parameters:

searchstring -

AllMustPass -

result -

Throws:

java.lang.Exception

AddTopLevelSearchBoxAndOperator

public static void AddTopLevelSearchBoxAndOperator(java.lang.String searchstring,
                                                   boolean AllMustPass,
                                                   boolean useVerboseTerminology,
                                                   HTMLElement textboxLabel,
                                                   HTMLElementCollection result,
                                                   java.lang.String strLang)

Parameters:

searchstring -

AllMustPass -

useVerboseTerminology -

textboxLabel -

result -

Throws:

java.lang.Exception

GetAddConditionButton

public static HTMLElement GetAddConditionButton(java.lang.String strLabel,
                                                java.lang.String strLang,
                                                AActivitySpace owner)

Returns an action bar style "button" (Anchor with attached image and text) for adding a search filter condition

Parameters:

strLabel - The label on the button

strLang - - The language to be used

owner - - The owning activity space where this will be used

Returns:

HTMLElement

Throws:

XPException

GetAddNewClauseButton

public static HTMLElement GetAddNewClauseButton(java.lang.String strLabel,
                                                java.lang.String strLang,
                                                AActivitySpace owner)

Returns an action bar style "button" (Anchor with attached image and text) for adding a search filter clause

Parameters:

strLabel - The label on the button

strLang - - The language to be used

owner - - The owning activity space where this will be used

Returns:

HTMLElement

Throws:

XPException

GetAllMustPass

public boolean GetAllMustPass()

Specified by:

GetAllMustPass in interface IFilterQueryTable

Returns:

GetDefinedQueryCondition

public QueryCondition GetDefinedQueryCondition(int iIndex)

Specified by:

GetDefinedQueryCondition in interface IFilterQueryTable

Parameters:

iIndex -

Returns:

GetJavaScript

public static HTMLElement GetJavaScript(java.lang.String submitString,
                                        AActivitySpace asOwner)

Returns JavaScript necessary for the Dynamic Query Table to work.

Parameters:

submitString - -

asOwner - - current Activity Space

Returns:

Throws:

java.lang.Exception

GetJavaScript

public static HTMLElement GetJavaScript(java.lang.String uniqueID,
                                        java.lang.String submitString,
                                        AActivitySpace asOwner)

Returns JavaScript necessary for the Dynamic Query Table to work.

Parameters:

submitString - -

asOwner - - current Activity Space

Returns:

Throws:

java.lang.Exception

GetTestButton

public static HTMLElement GetTestButton(java.lang.String label,
                                        java.lang.String script,
                                        AActivitySpace space)

GetRemoveClauseButton

public static HTMLElement GetRemoveClauseButton(java.lang.String strLabel,
                                                java.lang.String strLang,
                                                AActivitySpace owner)

Returns an action bar style "button" (Anchor with attached image and text) for removing a search filter clause

Parameters:

strLabel - The label on the button

strLang - - The language to be used

owner - - The owning activity space where this will be used

Returns:

HTMLElement

Throws:

XPException

GetRemoveLastConditionButton

public static HTMLElement GetRemoveLastConditionButton(java.lang.String strLabel,
                                                       java.lang.String strLang,
                                                       AActivitySpace owner)

Returns an action bar style "button" (Anchor with attached image and text) for removing the last search filter condition

Parameters:

strLabel - The label on the button

strLang - - The language to be used

owner - - The owning activity space where this will be used

Returns:

HTMLElement

Throws:

XPException

addTableToCollection

public void addTableToCollection(HTMLElementCollection result,
                                 boolean showErrorsNextToInputs,
                                 JSDateTimePickerMgr jsDateTimePickerMgr,
                                 PageMgr _ptPageMgr)

Specified by:

addTableToCollection in interface IFilterQueryTable

Parameters:

result -

showErrorsNextToInputs -

addTableToCollection

public void addTableToCollection(java.lang.String prefix,
                                 HTMLElementCollection result,
                                 boolean showErrorsNextToInputs,
                                 JSDateTimePickerMgr jsDateTimePickerMgr,
                                 PageMgr _ptPageMgr,
                                 boolean jitDatePicker)

Parameters:

result -

showErrorsNextToInputs -

loadDefinedQueryCondition

public void loadDefinedQueryCondition(QueryCondition qc)

Specified by:

loadDefinedQueryCondition in interface IFilterQueryTable

Parameters:

qc -

removeDefinedQueryCondition

public void removeDefinedQueryCondition(int iIndex)

Specified by:

removeDefinedQueryCondition in interface IFilterQueryTable

Parameters:

iIndex -