public interface PageConfig
extends com.technia.tvc.core.gui.common.RequestConfigurator
| Modifier and Type | Field and Description |
|---|---|
static int |
ADD_TO_COLLECTION_BUTTON
The button that allows users to add objects to collections.
|
static int |
ADVANCED_FILTER_BUTTON
The advanced filter button.
|
static int |
ADVANCED_SORT_BUTTON
The advanced sort button.
|
static int |
CHART_BUTTON
The button that opens a chart dialog.
|
static int |
CLIPBOARD_BUTTON
This represents the button that opens the clipboard and the buttons that
add objects to the clipboard.
|
static int |
COLUMN_FILTER_BUTTON
The column filter button.
|
static int |
COMPARE_BUTTON |
static int |
DATA_GROUP_BUTTON
The button that allows the user to perform data grouping.
|
static int |
DEMOTE_BUTTON |
static int |
DISCONNECT_BUTTON
The disconnect button.
|
static int |
EXPAND_ALL_BUTTON
The expand all button that may be displayed on structure pages.
|
static int |
EXPORT_TABLE_DATA_BUTTON
The export button.
|
static int |
FILTER_CHOOSER
The filter chooser.
|
static int |
FLATTEN_STRUCTURE_BUTTON
The flatten structure button that may be displayed on structure pages.
|
static int |
FORCERELOAD_BUTTON
The button that allows the force reload the page config data
|
static int |
GO_THERE_BUTTON
The go there button on each table row.
|
static int |
MANAGE_COLLECTIONS_BUTTON
The button that allows users to manage their collections.
|
static int |
MAXIMIZE_BUTTON
The button that allows the user to maximize the window
|
static int |
PREFERENCES_BUTTON
The buttons that opens the preferences dialog.
|
static int |
PRINTER_FRIENDLY_BUTTON
The printer friendly button.
|
static int |
PROMOTE_BUTTON |
static int |
RELOAD_BUTTON
The reload button.
|
static int |
ROW_COUNT
An column on the left hand side that displays the row count.
|
static int |
SEARCH_IN_STRUCTURE_BUTTON
The button that starts a search in structure.
|
static int |
TABLE_CHOOSER
The table chooser.
|
static int |
TOGGLE_EDIT_BUTTON
The toggle edit mode button.
|
static int |
TRIGGER_VALIDATION_BUTTON |
static int |
VIEW_CHOOSER
The view chooser.
|
static int |
WRAP_BUTTON |
| Modifier and Type | Method and Description |
|---|---|
void |
addChoosableView(java.lang.String choosableView)
Adds a choosable view.
|
void |
addCustomParameter(java.lang.String name,
java.lang.String value)
Adds a custom parameter.
|
void |
addView(View view) |
void |
clearChoosableViews()
Removes all choosable views.
|
void |
clearCustomParameters()
Removes all custom parameters and their values.
|
PageConfig |
copy()
Returns a copy.
|
java.lang.String[] |
getChoosableViews()
Returns the names of the choosable views.
|
java.lang.String |
getContextMenu()
Returns the name of the context menu.
|
java.lang.String |
getCustomParameter(java.lang.String name)
Returns the value of a custom parameter.
|
java.util.Iterator<java.lang.String> |
getCustomParameterNames()
Returns the names of all custom parameters.
|
java.lang.String[] |
getCustomParameterValues(java.lang.String name)
Returns the values of a custom parameter.
|
PageConfig |
getDef()
Returns the definition that the
PageConfig was loaded from. |
MultilingualText |
getHeader() |
int |
getInitialExpandLevel() |
java.lang.String |
getName()
Returns the name of the
PageConfig, if any. |
com.technia.tvc.core.gui.common.RowSelectType |
getRowSelection() |
MultilingualText |
getSubHeader() |
java.lang.String |
getTableBeanClass()
Returns the name of the
TableBean class that should be used on
the page. |
java.lang.String |
getToolBar() |
java.lang.String |
getView()
Returns the name of the default view.
|
java.util.Map<java.lang.String,View> |
getViews() |
int |
getVisible()
Returns all the visible elements.
|
java.lang.String[] |
getVisibles() |
void |
hide(int elements)
Hide UI elements.
|
void |
hideAll()
Hide all UI elements.
|
void |
hideAllExcept(int elements)
Hide all UI elements except the ones defined by the argument.
|
boolean |
isHeaderHTML() |
boolean |
isInitiallyEditable() |
boolean |
isReadOnly()
Returns true if readonly.
|
boolean |
isSubHeaderHTML() |
boolean |
isViewChoosable(java.lang.String view)
Checks whether a certain view is choosable.
|
boolean |
isVisible(int elements)
Checks whether all the specified elements are visible.
|
boolean |
isVisibleAddToCollectionButton() |
boolean |
isVisibleAdvancedFilterButton() |
boolean |
isVisibleAdvancedSortButton() |
boolean |
isVisibleChartButton() |
boolean |
isVisibleClipboardButton() |
boolean |
isVisibleColumnFilterButton() |
boolean |
isVisibleCompare() |
boolean |
isVisibleDataGroupButton() |
boolean |
isVisibleDemote() |
boolean |
isVisibleDisconnectButton()
Returns whether disconnect is available.
|
boolean |
isVisibleExpandAllButton() |
boolean |
isVisibleExportTableDataButton() |
boolean |
isVisibleFilterChooser() |
boolean |
isVisibleFlattenStructureButton() |
boolean |
isVisibleForceReloadButton() |
boolean |
isVisibleGoThereButton() |
boolean |
isVisibleManageCollectionsButton() |
boolean |
isVisibleMaximizeButton() |
boolean |
isVisiblePreferencesButton() |
boolean |
isVisiblePrinterFriendlyButton() |
boolean |
isVisiblePromote() |
boolean |
isVisibleReloadButton() |
boolean |
isVisibleRowCount() |
boolean |
isVisibleSearchInStructureButton()
Returns whether search in structure is available.
|
boolean |
isVisibleTableChooser() |
boolean |
isVisibleToggleEditButton() |
boolean |
isVisibleTriggerValidation() |
boolean |
isVisibleViewChooser() |
boolean |
isVisibleWrapButton()
Returns whether end user wrap of contents is available.
|
void |
removeChoosableView(java.lang.String choosableView)
Removes a choosable view.
|
void |
removeCustomParameter(java.lang.String name,
java.lang.String value)
Removes a specific value of a custom parameter.
|
void |
removeCustomParameterValues(java.lang.String name)
Removes all values of a custom parameter.
|
void |
setContextMenu(java.lang.String contextMenu)
Sets the name of the context menu.
|
void |
setHeader(MultilingualText header) |
void |
setHeaderHTML(boolean isHTML) |
void |
setInitialExpandLevel(int initialExpandLevel) |
void |
setInitiallyEditable(boolean initiallyEditable) |
void |
setRowSelection(com.technia.tvc.core.gui.common.RowSelectType rowSelection) |
void |
setSubHeader(MultilingualText subHeader) |
void |
setSubHeaderHTML(boolean isHTML) |
void |
setTableBeanClass(java.lang.String tableBeanClass)
Set the name of the
TableBean class to use. |
void |
setToolBar(java.lang.String toolBar) |
void |
setView(java.lang.String view)
Sets the default view.
|
void |
setVisibleAddToCollectionButton(boolean visible) |
void |
setVisibleAdvancedFilterButton(boolean visible) |
void |
setVisibleAdvancedSortButton(boolean visible) |
void |
setVisibleChartButton(boolean visible) |
void |
setVisibleClipboardButton(boolean visible) |
void |
setVisibleColumnFilterButton(boolean visible) |
void |
setVisibleCompare(boolean visible) |
void |
setVisibleDataGroupButton(boolean visible) |
void |
setVisibleDemote(boolean visible) |
void |
setVisibleDisconnectButton(boolean visible) |
void |
setVisibleExpandAllButton(boolean visible) |
void |
setVisibleExportTableDataButton(boolean visible) |
void |
setVisibleFilterChooser(boolean visible) |
void |
setVisibleFlattenStructureButton(boolean visible) |
void |
setVisibleForceReloadButton(boolean visible) |
void |
setVisibleGoThereButton(boolean visible) |
void |
setVisibleManageCollectionsButton(boolean visible) |
void |
setVisibleMaximizeButton(boolean visible) |
void |
setVisiblePreferencesButton(boolean visible) |
void |
setVisiblePrinterFriendlyButton(boolean visible) |
void |
setVisiblePromote(boolean visible) |
void |
setVisibleReloadButton(boolean visible) |
void |
setVisibleRowCount(boolean visible) |
void |
setVisibleSearchInStructureButton(boolean visible)
Sets whether search in structure is available.
|
void |
setVisibleTableChooser(boolean visible) |
void |
setVisibleToggleEditButton(boolean visible) |
void |
setVisibleTriggerValidation(boolean visible) |
void |
setVisibleViewChooser(boolean visible) |
void |
setVisibleWrapButton(boolean visible)
Sets whether end user wrap of contents in structure is available.
|
void |
show(int elements)
Show UI elements.
|
void |
showAll()
Show all elements.
|
static final int VIEW_CHOOSER
static final int TABLE_CHOOSER
static final int FILTER_CHOOSER
static final int TOGGLE_EDIT_BUTTON
static final int SEARCH_IN_STRUCTURE_BUTTON
static final int PREFERENCES_BUTTON
static final int RELOAD_BUTTON
static final int GO_THERE_BUTTON
static final int FLATTEN_STRUCTURE_BUTTON
static final int EXPAND_ALL_BUTTON
static final int DISCONNECT_BUTTON
static final int COLUMN_FILTER_BUTTON
static final int CLIPBOARD_BUTTON
static final int CHART_BUTTON
static final int ADVANCED_SORT_BUTTON
static final int ADVANCED_FILTER_BUTTON
static final int ROW_COUNT
static final int PRINTER_FRIENDLY_BUTTON
static final int EXPORT_TABLE_DATA_BUTTON
static final int ADD_TO_COLLECTION_BUTTON
static final int MANAGE_COLLECTIONS_BUTTON
static final int MAXIMIZE_BUTTON
static final int DATA_GROUP_BUTTON
static final int TRIGGER_VALIDATION_BUTTON
static final int COMPARE_BUTTON
static final int PROMOTE_BUTTON
static final int DEMOTE_BUTTON
static final int WRAP_BUTTON
static final int FORCERELOAD_BUTTON
java.lang.String getName()
PageConfig, if any.void hideAll()
void hideAllExcept(int elements)
elements - The elements that should remain visible.void hide(int elements)
elements - The elements that should be hidden. All other elements
will remain visible if they are.void show(int elements)
elements - The elements that should be shown. If other elements are
shown prior to calling this method they will remain as they are.void showAll()
boolean isVisible(int elements)
elements - The elements to check.int getVisible()
java.lang.String getView()
void setView(java.lang.String view)
view - The new default view.java.lang.String[] getChoosableViews()
void addChoosableView(java.lang.String choosableView)
choosableView - The new choosable view.void removeChoosableView(java.lang.String choosableView)
choosableView - the choosable view to remove.void clearChoosableViews()
boolean isViewChoosable(java.lang.String view)
view - A view.java.lang.String getTableBeanClass()
TableBean class that should be used on
the page.TableBean class that should be
used on the page.void setTableBeanClass(java.lang.String tableBeanClass)
TableBean class to use.tableBeanClass - The new TableBean class name.java.lang.String getContextMenu()
void setContextMenu(java.lang.String contextMenu)
contextMenu - The new context menu name.java.util.Iterator<java.lang.String> getCustomParameterNames()
java.lang.String getCustomParameter(java.lang.String name)
name - The name of the custom parameter.java.lang.String[] getCustomParameterValues(java.lang.String name)
name - The name of the parameter.void addCustomParameter(java.lang.String name,
java.lang.String value)
name - The name of the custom parameter.value - The value to add.void removeCustomParameter(java.lang.String name,
java.lang.String value)
name - The name of the custom parameter.value - The value to remove.void removeCustomParameterValues(java.lang.String name)
name - The name of the custom parameter.void clearCustomParameters()
boolean isVisibleSearchInStructureButton()
void setVisibleSearchInStructureButton(boolean visible)
visible - Whether the button is visible or not.boolean isVisibleDisconnectButton()
void setVisibleDisconnectButton(boolean visible)
boolean isVisiblePrinterFriendlyButton()
void setVisiblePrinterFriendlyButton(boolean visible)
boolean isVisibleAdvancedFilterButton()
void setVisibleAdvancedFilterButton(boolean visible)
boolean isVisibleExportTableDataButton()
void setVisibleExportTableDataButton(boolean visible)
boolean isVisibleAddToCollectionButton()
void setVisibleAddToCollectionButton(boolean visible)
boolean isVisibleManageCollectionsButton()
void setVisibleManageCollectionsButton(boolean visible)
boolean isVisibleColumnFilterButton()
void setVisibleColumnFilterButton(boolean visible)
boolean isVisiblePreferencesButton()
void setVisiblePreferencesButton(boolean visible)
boolean isVisibleChartButton()
void setVisibleChartButton(boolean visible)
int getInitialExpandLevel()
void setInitialExpandLevel(int initialExpandLevel)
com.technia.tvc.core.gui.common.RowSelectType getRowSelection()
void setRowSelection(com.technia.tvc.core.gui.common.RowSelectType rowSelection)
boolean isVisibleClipboardButton()
void setVisibleClipboardButton(boolean visible)
boolean isVisibleFlattenStructureButton()
void setVisibleFlattenStructureButton(boolean visible)
boolean isVisibleRowCount()
void setVisibleRowCount(boolean visible)
java.lang.String getToolBar()
void setToolBar(java.lang.String toolBar)
MultilingualText getHeader()
void setHeader(MultilingualText header)
boolean isHeaderHTML()
void setHeaderHTML(boolean isHTML)
MultilingualText getSubHeader()
void setSubHeader(MultilingualText subHeader)
boolean isSubHeaderHTML()
void setSubHeaderHTML(boolean isHTML)
boolean isVisibleViewChooser()
void setVisibleViewChooser(boolean visible)
boolean isVisibleTableChooser()
void setVisibleTableChooser(boolean visible)
boolean isVisibleFilterChooser()
void setVisibleFilterChooser(boolean visible)
boolean isVisibleReloadButton()
boolean isVisibleForceReloadButton()
boolean isVisibleMaximizeButton()
void setVisibleMaximizeButton(boolean visible)
void setVisibleReloadButton(boolean visible)
void setVisibleForceReloadButton(boolean visible)
boolean isVisibleToggleEditButton()
void setVisibleToggleEditButton(boolean visible)
boolean isVisibleAdvancedSortButton()
void setVisibleAdvancedSortButton(boolean visible)
boolean isVisibleExpandAllButton()
void setVisibleExpandAllButton(boolean visible)
boolean isVisibleGoThereButton()
void setVisibleGoThereButton(boolean visible)
boolean isInitiallyEditable()
void setInitiallyEditable(boolean initiallyEditable)
boolean isVisibleDataGroupButton()
void setVisibleDataGroupButton(boolean visible)
java.lang.String[] getVisibles()
boolean isReadOnly()
PageConfig is readonly you can't
modify its internal state. Attempts to do so will result in an
IllegalStateException.PageConfig is readonly.PageConfig copy()
PageConfig. The new copy will not
be readonly.PageConfig getDef()
PageConfig was loaded from. If
the PageConfig wasn't loaded from a definition this method will
return null.boolean isVisibleTriggerValidation()
void setVisibleTriggerValidation(boolean visible)
visible - True if the trigger validation buttons should be visible.boolean isVisibleCompare()
void setVisibleCompare(boolean visible)
visible - True if the compare button should be visible.boolean isVisiblePromote()
void setVisiblePromote(boolean visible)
visible - True if the promote button should be visible.boolean isVisibleDemote()
void setVisibleDemote(boolean visible)
visible - True if the demote button should be visible.void addView(View view)
view - Save selected view with table and filtersjava.util.Map<java.lang.String,View> getViews()
void setVisibleWrapButton(boolean visible)
visible - Whether the button is visible or not.boolean isVisibleWrapButton()
Copyright ? Technia AB. All Rights Reserved.