com.sap.netweaver.bc.uwl.config

Class UWLView

java.lang.Object
  com.sap.netweaver.bc.uwl.config.UWLView

All Implemented Interfaces:

Serializable, Cloneable

public final class UWLView
extends Object
implements Cloneable, Serializable

UWLView will define the characteristics used to create a Table for displaying the list of items return by the specified ItemTypes.

The UWL view will control the table size, columns to display, sort information, and other information which is defined in the standard or custom XML file. (see example XML)

<View name="DefaultView" width="98%" supportedItemTypes="uwl.task" columnOrder="subject, isEscalated, creatorId, createdDate, priority, attachmentCount, dueDate, status" sortby="priority:descend, dueDate:ascend, createdDate:descend" selectionMode="SINGLESELECT" tableDesign="STANDARD" visibleRowCount="10" headerVisible="no" tableNavigationFooterVisible="yes"...

In the UWL filters can also be defined to allow the user to narrow down the result set easier.

Table Header - Title (See getHeaderText() and isHeaderVisible())
Column Header 1 (See getColumnOrder()	Column Header 2	Column Header 3
Row 1 (See getVisbleRowSize())
Row 2
Table Footer - Table Navigation Area (See isFooterVisible())

See Also:

DisplayAttribute, CompoundExpression, Serialized Form

Field Summary

static String	DESIGN_ALTERNATING Used as a value to pass to the method setTableDesign(java.lang.String)
static String	DESIGN_STANDARD Used as a value to pass to the method setTableDesign(java.lang.String)
static String	EMPHASIZEDITEMS_NEW Used as a value to pass to the method setEmphasizedItems(java.lang.String)
static String	EMPHASIZEDITEMS_NONE Used as a value to pass to the method setEmphasizedItems(java.lang.String)
static String	EMPHASIZEDITEMS_UNREAD Used as a value to pass to the method setEmphasizedItems(java.lang.String)
static String	NAV_BRIEF Used as a value to pass to the method setTableNavigationMode(java.lang.String)
static String	NAV_POWER Used as a value to pass to the method setTableNavigationMode(java.lang.String)
static String	NAV_STANDARD Used as a value to pass to the method setTableNavigationMode(java.lang.String)
static String	PERSONAL_VIEW Used to indicate this is a personalized view.
static String	SELECTION_MULTI Used as a value to pass to the method setSelectionMode(java.lang.String)
static String	SELECTION_NONE Used as a value to pass to the method setSelectionMode(java.lang.String)
static String	SELECTION_SINGLE Used as a value to pass to the method setSelectionMode(java.lang.String)
static String	SYSTEM_VIEW Used to indicate the owner of the View.
static String	UWL_DEFAULT_SORTBY_NAME Used as the name of a SortGroup to indicate the main sortBy properties should be used.

Constructor Summary

UWLView()
Constructor.

Method Summary

void	addAllowedFilters(CompoundExpression ceRet) Method addAllowedFilters.
void	addFilter(CompoundExpression filter) Method addFilter.
Object	clone()
void	deleteFilter(CompoundExpression filter) Method deleteFilter.
String	getActionPosition() Determine where in the Table the Global actions should be displayed.
String	getActionRef() Returns the actions names which are to be used in the global action section.
String[]	getColumnOrder() Returns the columnOrder.
String[]	getColumnsWhichHaveDisplayAttributes()
CompoundExpression	getDefaultFilter() Returns the defaultFilter.
DisplayAttribute	getDisplayAttribute(String name) Return the Display Attribute by its name.
List	getDisplayAttributeForGroupAction() Get a list of all the DisplayAttributes which have an Action of type User Decision assigned to them.
DisplayAttributes	getDisplayAttributes() Returns the displayAttributes.
DisplayAttribute[]	getDisplayAttributesWhichHaveColumns() A View has many display attributes defined.
Descriptions	getDisplayName() Returns the displayName.
String	getEmphasizedItems() This is used to determine if the return items should be displayed as emphasized.
CompoundExpression[]	getFilters() Returns the filters.
Action	getGlobalAction(String name) Return action which should be displayed in the Table (First row or Bottom row) by its name.
Action[]	getGlobalActions() Return actions which should be displayed in the Table (First row or Bottom row).
String	getGroupColumn() Returns the groupColumn.
String	getHeaderText() Deprecated. Use the getDescription method to support localization.
long	getIndicateDueDateSevere()
long	getIndicateDueDateWarning()
String[]	getItemTypes() Returns the itemTypes.
Set	getItemTypesSet() Return the supported ItemTypes as a Set.
String	getLongText(Locale locale) Get the long text for the specified locale.
String	getName() Returns the name.
String	getNamespace() Deprecated. This is no longer used.
String	getOwner() This is used internaly to determine if this is a system or personalzied view.
DateFilterEnum	getQueryTimeRange() Specify how far to go back to get items.
String	getReferenceBundle() Used internally
long	getRefreshRate()
String	getSelectionMode() Returns the selectionMode.
String	getShortText(Locale locale) Return the display name text for the specified Locale.
String[]	getSortColumnNames() Return the SortColumn names only with out the direction.
String[]	getSortColumnNames(String selectedSortGroupName) Return the sort order for the specified SortGroupName.
String[]	getSortColumns() Returns the sortColumns, also has ascend or desending appended to the names.
UWLSortGroup	getSortGroup(String name) This is a new feature for the WebDynpro Table Grouping.
UWLSortGroup[]	getSortGroups() This is a new feature for the WebDynpro Table Grouping.
boolean[]	getSortOrder() Return a array of booleans which correspond to the sort columns to indicate (true) ascending or (false) descending order.
boolean[]	getSortOrder(String selectedSortGroupName) Return the sort direction for the specified SortGroupName.
String	getTableDesign() Returns the tableDesign.
String	getTableNavigationMode() Deprecated. This only support in the HTMLB versions
int	getVisbleRowSize() Returns the visbleRowSize.
String	getWidth() Returns the width.
boolean	globalReferencesInitialized() For internal use only
boolean	isDisplayOnlyDefinedAttributes() Used to determine if only the Defined Attributes in a item shuld be displayed in the preview area.
boolean	isDynamicCreationAllowed() This used to determine, when create dynamic views in the Navigation node, if this view should be included.
boolean	isEmphasizedItemsNew() Indicates if the items should not be Emphasized if they are new
boolean	isEmphasizedItemsNone() Indicates if the items should not be Emphasized
boolean	isEmphasizedItemsUnread() Indicates if the items should be Emphasized if they are unread
boolean	isFooterVisible() Returns the footerVisible.
boolean	isHeaderVisible() Returns the headerVisible.
boolean	isPersonalized() If the user has saved the view then this flag will be true.
void	setActionPosition(String string) Indicate if the actions are to be display at the top or bottom of the Table.
void	setActionRef(String string) used internally only
void	setColumnOrder(String[] columnOrder) Sets the columnOrder.
void	setDefaultFilter(CompoundExpression defaultFilter) Sets the defaultFilter.
void	setDisplayAttributes(DisplayAttributes da) Method setDisplayAttributes.
void	setDisplayAttributesForGroupAction(List li) For internal use only
void	setDisplayName(Descriptions descriptions) Sets the displayName.
void	setDisplayOnlyDefinedAttributes(boolean b)
void	setDynamicCreationAllowed(boolean b) Allow this view to be added to the dynamic Navigation node list.
void	setEmphasizedItems(String string) Set how the items should be displayed.
void	setFilters(CompoundExpression[] filters) Sets the filters.
void	setFooterVisible(boolean footerVisible) Sets the footerVisible.
void	setGlobalActions(Action[] globalActions) Sets the globalActions.
void	setGlobalReferencesInitialized() For internal use only
void	setGroupColumn(String groupColumn) Sets the groupColumn.
void	setHeaderText(String headerText) Deprecated. use setDisplayName to support localization
void	setHeaderVisible(boolean headerVisible) Sets the headerVisible.
void	setIndicateDueDateSevere(long l) Set when the the item should marked as severe when the due date is getting near.
void	setIndicateDueDateSevere(String value) Set when the the item should marked as severe when the due date is getting near.
void	setIndicateDueDateSevereDays(int days) Set when the the item should marked as severe when the due date is getting near.
void	setIndicateDueDateWarning(long l) Set when the the item should marked as warning when the due date is getting near.
void	setIndicateDueDateWarning(String value) Set when the the item should marked as warning when the due date is getting near.
void	setIndicateDueDateWarningDays(int days) Set when the the item should marked as warning when the due date is getting near.
void	setItemTypes(HashSet itemTyp) Sets the itemTypes.
void	setName(String name) Sets the name.
void	setNameSpace(String nameSpace) Deprecated. This is no longer used
void	setOwner(String string) This is used internaly to set if this is a system or personalzied view.
void	setPersonalized(boolean b) This is used internaly to determine if user has personalzied view.
void	setQueryTimeRange(DateFilterEnum dateFilterEnum) Specify how far back to retrieve item data for.
void	setQueryTimeRange(String value) Specify how far back to retrieve item data for.
void	setReferenceBundle(String ref) Used internally to set DisplayName in the xml file
void	setRefreshRate(long l) Set the refresh Rate in seconds.
void	setRefreshRate(String value) Set the timer to have the UWL UI page check for new items.
void	setRefreshRateMinutes(int i) Set the refresh Rate in minutes.
void	setSelectionMode(String selectionMode) Sets the selectionMode.
void	setSortColumns(String[] sortColumns) Sets the columns and direction in which the item will be sorted on when displayed to the user.
void	setSortGroups(UWLSortGroup[] sortGroups) This is a new feature for the WebDynpro Table Grouping.
void	setTableDesign(String tableDesign) Sets the tableDesign.
void	setTableNavigationMode(String tableNavigationMode) Deprecated. This only support in the HTMLB versions
void	setVisbleRowSize(int visbleRowSize) Sets the visbleRowSize.
void	setWidth(String width) Sets the width.

Methods inherited from class java.lang.Object

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

Field Detail

DESIGN_ALTERNATING

public static final String DESIGN_ALTERNATING

Used as a value to pass to the method setTableDesign(java.lang.String)

See Also:

Constant Field Values

DESIGN_STANDARD

public static final String DESIGN_STANDARD

Used as a value to pass to the method setTableDesign(java.lang.String)

See Also:

Constant Field Values

NAV_STANDARD

public static final String NAV_STANDARD

Used as a value to pass to the method setTableNavigationMode(java.lang.String)

See Also:

Constant Field Values

NAV_POWER

public static final String NAV_POWER

Used as a value to pass to the method setTableNavigationMode(java.lang.String)

See Also:

Constant Field Values

NAV_BRIEF

public static final String NAV_BRIEF

Used as a value to pass to the method setTableNavigationMode(java.lang.String)

See Also:

Constant Field Values

SELECTION_NONE

public static final String SELECTION_NONE

Used as a value to pass to the method setSelectionMode(java.lang.String)

See Also:

Constant Field Values

SELECTION_SINGLE

public static final String SELECTION_SINGLE

Used as a value to pass to the method setSelectionMode(java.lang.String)

See Also:

Constant Field Values

SELECTION_MULTI

public static final String SELECTION_MULTI

Used as a value to pass to the method setSelectionMode(java.lang.String)

See Also:

Constant Field Values

EMPHASIZEDITEMS_NONE

public static final String EMPHASIZEDITEMS_NONE

Used as a value to pass to the method setEmphasizedItems(java.lang.String)

See Also:

Constant Field Values

EMPHASIZEDITEMS_UNREAD

public static final String EMPHASIZEDITEMS_UNREAD

Used as a value to pass to the method setEmphasizedItems(java.lang.String)

See Also:

Constant Field Values

EMPHASIZEDITEMS_NEW

public static final String EMPHASIZEDITEMS_NEW

Used as a value to pass to the method setEmphasizedItems(java.lang.String)

See Also:

Constant Field Values

UWL_DEFAULT_SORTBY_NAME

public static final String UWL_DEFAULT_SORTBY_NAME

Used as the name of a SortGroup to indicate the main sortBy properties should be used. This will allow the user to still be able to customize the default sort order and still have new SortGroup for the user to select from, which are sort orders defined by the administrator.

See Also:

Constant Field Values

SYSTEM_VIEW

public static final String SYSTEM_VIEW

Used to indicate the owner of the View. System indicates the view was created by the system or custom XML file configuration.

See Also:

Constant Field Values

PERSONAL_VIEW

public static final String PERSONAL_VIEW

Used to indicate this is a personalized view. The clone method will automatically change the owner of a view to this type.

See Also:

Constant Field Values

Constructor Detail

UWLView

public UWLView()

Constructor. Creates an empty UWLView.

Method Detail

addFilter

public void addFilter(CompoundExpression filter)

Method addFilter. Add a filters which can be applied to the view. The filter can be used to narrow down the number of items displayed.

Parameters:

filter -

deleteFilter

public void deleteFilter(CompoundExpression filter)

Method deleteFilter. Remove a filter selection for the view.

Parameters:

filter -

getColumnOrder

public String[] getColumnOrder()

Returns the columnOrder. This is the names of the DisplayAttribute which will be used to create the Table columns. The array of names are return in the exact order in which the columns should be created.

Returns:

String[]

See Also:

DisplayAttribute

getDefaultFilter

public CompoundExpression getDefaultFilter()

Returns the defaultFilter. If there is a default filter defined then this will return the filter otherwise null is returned.

Returns:

CompoundExpression

getDisplayAttributes

public DisplayAttributes getDisplayAttributes()

Returns the displayAttributes. This is a collection of all the attribute which can be displayed by this view. This maybe contain more attributes then what is defined in the columnOrder. This is used to allow the user to personalize this view and add additional columns to there display.

Returns:

DisplayAttributes

See Also:

getColumnOrder()

getDisplayAttribute

public DisplayAttribute getDisplayAttribute(String name)

Return the Display Attribute by its name. When getting the column order this is used to get the corresponding display attribute.

Parameters:

name -

Returns:

If the name is no supported by this View then null is returned.

See Also:

getDisplayAttributes(), getColumnOrder()

getShortText

public String getShortText(Locale locale)

Return the display name text for the specified Locale.

Parameters:

locale -

Returns:

None NULL string will be returned. If the desired Text is not found then an empty string is returned.

getLongText

public String getLongText(Locale locale)

Get the long text for the specified locale. This is the Text used to create the tooltip.

Parameters:

locale -

Returns:

None NULL string will be returned. If the desired Text is not found then an empty string is returned.

getDisplayName

public Descriptions getDisplayName()

Returns the displayName. This is the Name to be used when displaying the Table Header. Use the getSortText or GetLongText method to avoid null strings

Returns:

Descriptions Maybe null

getFilters

public CompoundExpression[] getFilters()

Returns the filters. Get all possible filters which are supported by this view.

Returns:

CompoundExpression[]

isFooterVisible

public boolean isFooterVisible()

Returns the footerVisible. Indicate if the footer part of the Table, which is used to determine if the table navigation controls, should be displayed.

Returns:

boolean

getGlobalActions

public Action[] getGlobalActions()

Return actions which should be displayed in the Table (First row or Bottom row). These action will apply to the selected item(s) in the table.

Returns:

Action[]

getGlobalAction

public Action getGlobalAction(String name)

Return action which should be displayed in the Table (First row or Bottom row) by its name.

Parameters:

name -

Returns:

getGroupColumn

public String getGroupColumn()

Returns the groupColumn. Currenly not used (Future enhancement to allow grouping items together.)

Returns:

String

getHeaderText

public String getHeaderText()

Deprecated. Use the getDescription method to support localization.

Returns the headerText. (Not used.)

Returns:

String

isHeaderVisible

public boolean isHeaderVisible()

Returns the headerVisible. Determine if the Table header should be displayed or not. The Table Header is used to display Title and in some cases the Search/Filter input box.

Returns:

boolean

getItemTypes

public String[] getItemTypes()

Returns the itemTypes. This is the ItemType in which this view will display. The item types are used when requesting the data set from the UWLService. This is the list of item types which are to be displayed when the view is used.

Returns:

String[]

getSelectionMode

public String getSelectionMode()

Returns the selectionMode. This the selection mode to be used.

                NONE - No row selection allowed.
                SINGLESELECT - Only one row can be selected at a time.
                MULTISELECT - One or more rows can be selected.
 

Returns:

String

getSortColumns

public String[] getSortColumns()

Returns the sortColumns, also has ascend or desending appended to the names.

Returns:

String

See Also:

getSortColumnNames(), getSortOrder()

getTableDesign

public String getTableDesign()

Returns the tableDesign.

        ALTERNATING 
        STANDARD
  TRANSPARENT
 

Returns:

String

getTableNavigationMode

public String getTableNavigationMode()

Deprecated. This only support in the HTMLB versions

Returns the tableNavigationMode.

        STANDARD
  POWERNAV
        BRIEFNAV
        CUSTOMNAV
 

Returns:

String

getVisbleRowSize

public int getVisbleRowSize()

Returns the visbleRowSize. Return the max number of items to display per table page. This is default value to use if the IView parameter or the user personalization has not been set.

Returns:

int

getWidth

public String getWidth()

Returns the width. Return the desired width of the table. Note due to the nature of HTML tables the table maybe displayed larger to show all data in the table.

Returns:

String

setColumnOrder

public void setColumnOrder(String[] columnOrder)

Sets the columnOrder. This is the names of the DisplayAttribute to be displayed in the table. The DisplayAttribute must be supported for this view or adding the name will have no effect.

Parameters:

columnOrder - The columnOrder to set

See Also:

getDisplayAttributes(), getColumnOrder()

setDefaultFilter

public void setDefaultFilter(CompoundExpression defaultFilter)

Sets the defaultFilter.

Parameters:

defaultFilter - The defaultFilter to set

setDisplayName

public void setDisplayName(Descriptions descriptions)

Sets the displayName.

Parameters:

displayName - The displayName to set

setFooterVisible

public void setFooterVisible(boolean footerVisible)

Sets the footerVisible.

Parameters:

footerVisible - The footerVisible to set

See Also:

isFooterVisible()

setGlobalActions

public void setGlobalActions(Action[] globalActions)

Sets the globalActions.

Parameters:

globalActions - The globalActions to set

See Also:

getGlobalActions()

setGroupColumn

public void setGroupColumn(String groupColumn)

Sets the groupColumn. (This is currently not used)

Parameters:

groupColumn - The groupColumn to set

setHeaderText

public void setHeaderText(String headerText)

Deprecated. use setDisplayName to support localization

Sets the headerText.

Parameters:

headerText - The headerText to set

setHeaderVisible

public void setHeaderVisible(boolean headerVisible)

Sets the headerVisible.

Parameters:

headerVisible - The headerVisible to set

setNameSpace

public void setNameSpace(String nameSpace)

Deprecated. This is no longer used

Sets the nameSpace.

Parameters:

nameSpace - The nameSpace to set

setSelectionMode

public void setSelectionMode(String selectionMode)

Sets the selectionMode.

Parameters:

selectionMode - The selectionMode to set

See Also:

getSelectionMode()

setSortColumns

public void setSortColumns(String[] sortColumns)

Sets the columns and direction in which the item will be sorted on when displayed to the user. The sort direction can be defined along with column name.

Example {"subject:desc","priority:asc"}
Note: Maximum of 3 sort columns can be defined at a time.

Parameters:

sortColumns - The sortColumns to set

See Also:

getSortColumns()

setTableDesign

public void setTableDesign(String tableDesign)

Sets the tableDesign.

Parameters:

tableDesign - The tableDesign to set

See Also:

getTableDesign()

setTableNavigationMode

public void setTableNavigationMode(String tableNavigationMode)

Deprecated. This only support in the HTMLB versions

Sets the tableNavigationMode.

Parameters:

tableNavigationMode - The tableNavigationMode to set

See Also:

getTableNavigationMode()

setVisbleRowSize

public void setVisbleRowSize(int visbleRowSize)

Sets the visbleRowSize.

Parameters:

visbleRowSize - The visbleRowSize to set

setWidth

public void setWidth(String width)

Sets the width.

Parameters:

width - The width to set

getName

public String getName()

Returns the name. This is the internal name of the view. This name must be unique.

Returns:

String

setName

public void setName(String name)

Sets the name.

Parameters:

name - The name to set

addAllowedFilters

public void addAllowedFilters(CompoundExpression ceRet)

Method addAllowedFilters.

Parameters:

ceRet -

setDisplayAttributes

public void setDisplayAttributes(DisplayAttributes da)

Method setDisplayAttributes. This is the set of DisplayAttributes which are support by this view.

Parameters:

da -

getNamespace

public String getNamespace()

Deprecated. This is no longer used.

Returns the configuration name.

Returns:

String

setFilters

public void setFilters(CompoundExpression[] filters)

Sets the filters.

Parameters:

filters - The filters to set

setItemTypes

public void setItemTypes(HashSet itemTyp)

Sets the itemTypes.

Parameters:

itemTypes - The itemTypes to set

getItemTypesSet

public Set getItemTypesSet()

Return the supported ItemTypes as a Set. If there is no ItemTypes then an EMPTY_SET is returned.
NOTE: View must support at less one item type to be valid.

Returns:

getActionRef

public String getActionRef()

Returns the actions names which are to be used in the global action section. The action names can be common or space seperated. When the view is loaded the action names will be mergerd into the Global Action list. Actions which are not found will be ignored.

Returns:

null maybe return if no action names defined.

setActionRef

public void setActionRef(String string)

used internally only

Parameters:

string -

clone

public Object clone()
             throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

See Also:

Object.clone()

getOwner

public String getOwner()

This is used internaly to determine if this is a system or personalzied view.

See Also:

SYSTEM_VIEW, PERSONAL_VIEW

setOwner

public void setOwner(String string)

This is used internaly to set if this is a system or personalzied view.

Parameters:

string -

getIndicateDueDateSevere

public long getIndicateDueDateSevere()

Returns:

get the number of milseconds to determine due date severe. 0 is returned if none is required.

getIndicateDueDateWarning

public long getIndicateDueDateWarning()

Returns:

get the number of milseconds to determine due date warning 0 is returned if none is required.

getRefreshRate

public long getRefreshRate()

Returns:

get the number of seconds for the refresh rate. 0 is returned if none is required.

setIndicateDueDateSevere

public void setIndicateDueDateSevere(long l)

Set when the the item should marked as severe when the due date is getting near. Enter the number of milseconds.

Parameters:

l -

setIndicateDueDateSevereDays

public void setIndicateDueDateSevereDays(int days)

Set when the the item should marked as severe when the due date is getting near. Enter the number of days.

Parameters:

l -

setIndicateDueDateWarning

public void setIndicateDueDateWarning(long l)

Set when the the item should marked as warning when the due date is getting near. Enter the number of milseconds.

Parameters:

l -

setIndicateDueDateWarningDays

public void setIndicateDueDateWarningDays(int days)

Set when the the item should marked as warning when the due date is getting near. Enter the number of days.

Parameters:

l -

setRefreshRate

public void setRefreshRate(long l)

Set the refresh Rate in seconds. If 0 is used then no refresh is done.

Parameters:

l -

setRefreshRateMinutes

public void setRefreshRateMinutes(int i)

Set the refresh Rate in minutes. If 0 is used then no refresh is done.

Parameters:

i -

setIndicateDueDateSevere

public void setIndicateDueDateSevere(String value)

Set when the the item should marked as severe when the due date is getting near. Enter the number of milseconds in a String value. This used by the personalize page to allow the reflection update to work.

Parameters:

value -

setIndicateDueDateWarning

public void setIndicateDueDateWarning(String value)

Set when the the item should marked as warning when the due date is getting near. Enter the number of milseconds in a String value. This used by the personalize page to allow the reflection update to work.

Parameters:

value -

setRefreshRate

public void setRefreshRate(String value)

Set the timer to have the UWL UI page check for new items. This Method is used by the personalization page for java reflection to be able to update the field using a string value.

Parameters:

value -

See Also:

setRefreshRate(long), setRefreshRateMinutes(int)

getEmphasizedItems

public String getEmphasizedItems()

This is used to determine if the return items should be displayed as emphasized.

Returns:

"New", "Unread", "none", can be null also

See Also:

setEmphasizedItems(String)

setEmphasizedItems

public void setEmphasizedItems(String string)

Set how the items should be displayed.
Emphasized - unread
Emphasized - new
Emphasized - none

Parameters:

string -

See Also:

EMPHASIZEDITEMS_UNREAD, EMPHASIZEDITEMS_NEW, EMPHASIZEDITEMS_NONE

isEmphasizedItemsUnread

public boolean isEmphasizedItemsUnread()

Indicates if the items should be Emphasized if they are unread

Returns:

isEmphasizedItemsNone

public boolean isEmphasizedItemsNone()

Indicates if the items should not be Emphasized

Returns:

isEmphasizedItemsNew

public boolean isEmphasizedItemsNew()

Indicates if the items should not be Emphasized if they are new

Returns:

isDisplayOnlyDefinedAttributes

public boolean isDisplayOnlyDefinedAttributes()

Used to determine if only the Defined Attributes in a item shuld be displayed in the preview area. NOTE if this is true then the label for the data will be the same name as the Attribute.

Returns:

setDisplayOnlyDefinedAttributes

public void setDisplayOnlyDefinedAttributes(boolean b)

Parameters:

b -

See Also:

isDisplayOnlyDefinedAttributes()

getActionPosition

public String getActionPosition()

Determine where in the Table the Global actions should be displayed.

        TOP - First row of the Table
  BOTTOM - Last row of the Table.
  BOTH - (Future enhancement)
 

Returns:

setActionPosition

public void setActionPosition(String string)

Indicate if the actions are to be display at the top or bottom of the Table.
NOTE: this maynot be support in some release based off SAP UI designer specification. I.e.) In 710 the actions are to be placed in menus and navigate section only.

Parameters:

string -

See Also:

getActionPosition()

getReferenceBundle

public String getReferenceBundle()

Used internally

Returns:

setReferenceBundle

public void setReferenceBundle(String ref)

Used internally to set DisplayName in the xml file

Parameters:

ref -

isDynamicCreationAllowed

public boolean isDynamicCreationAllowed()

This used to determine, when create dynamic views in the Navigation node, if this view should be included. This view will be added if this flag is true and there are Items which has the ItemType supported by this view, and there is no other view already showing these item types in the navigation node.

NOTE: The higher the number of ItemTypes the more likely this view will be added, since there is a limit on the number of views to be added. Views with more ItemType are added first.

Returns:

True if this view should be included in the list return from the IUWLViewManager.getItemTypeNavigationNode(NavigationNode, String[], UWLContext, String, int, String, String) method

See Also:

IUWLViewManager.appendItemTypesWithItems(NavigationNode, UWLContext, String, int, String, String, ItemTypeCount[])

setDynamicCreationAllowed

public void setDynamicCreationAllowed(boolean b)

Allow this view to be added to the dynamic Navigation node list.

Parameters:

b -

See Also:

isDynamicCreationAllowed(), IUWLViewManager.appendItemTypesWithItems(NavigationNode, UWLContext, String, int, String, String, ItemTypeCount[])

getQueryTimeRange

public DateFilterEnum getQueryTimeRange()

Specify how far to go back to get items.

Returns:

setQueryTimeRange

public void setQueryTimeRange(DateFilterEnum dateFilterEnum)

Specify how far back to retrieve item data for.

Parameters:

enum -

setQueryTimeRange

public void setQueryTimeRange(String value)

Specify how far back to retrieve item data for.

Parameters:

enum - key

globalReferencesInitialized

public boolean globalReferencesInitialized()

For internal use only

Returns:

if gloabl display attributes and actions referred in the View definition are already resolved and loaded

setGlobalReferencesInitialized

public void setGlobalReferencesInitialized()

For internal use only

getDisplayAttributeForGroupAction

public List getDisplayAttributeForGroupAction()

Get a list of all the DisplayAttributes which have an Action of type User Decision assigned to them.

Returns:

setDisplayAttributesForGroupAction

public void setDisplayAttributesForGroupAction(List li)

For internal use only

Parameters:

li -

getSortOrder

public boolean[] getSortOrder()

Return a array of booleans which correspond to the sort columns to indicate (true) ascending or (false) descending order.

Returns:

getSortColumnNames

public String[] getSortColumnNames()

Return the SortColumn names only with out the direction.

Returns:

See Also:

getSortOrder()

getSortColumnNames

public String[] getSortColumnNames(String selectedSortGroupName)

Return the sort order for the specified SortGroupName. If the name is null or is the UWL_DEFAULT_SORTBY_NAME then the main sortBy field is used.

This is a new feature for the WebDynpro Table Grouping. Currently only in 710 release.

Parameters:

selectedSortGroupName -

Returns:

The column names which to be sorted on.

getSortOrder

public boolean[] getSortOrder(String selectedSortGroupName)

Return the sort direction for the specified SortGroupName. If the name is null or is the UWL_DEFAULT_SORTBY_NAME then the main sortBy field is used. Use this with the corresponding getSortColumnNames method.

This is a new feature for the WebDynpro Table Grouping. Currently only in 710 release.

Parameters:

selectedSortGroupName -

Returns:

boolean where true is ascending and false is descending order.

getColumnsWhichHaveDisplayAttributes

public String[] getColumnsWhichHaveDisplayAttributes()

Returns:

only columns which have display attribues defined in the view. All other columns are ignored.

getDisplayAttributesWhichHaveColumns

public DisplayAttribute[] getDisplayAttributesWhichHaveColumns()

A View has many display attributes defined. But only few columns are displayed. In such case, it makese sense to use only those display attributes which are relevant for display.

isPersonalized

public boolean isPersonalized()

If the user has saved the view then this flag will be true.

Returns:

setPersonalized

public void setPersonalized(boolean b)

This is used internaly to determine if user has personalzied view.

getSortGroups

public UWLSortGroup[] getSortGroups()

This is a new feature for the WebDynpro Table Grouping. Currently only in 710 release.

Returns:

Returns the sortGroups.

setSortGroups

public void setSortGroups(UWLSortGroup[] sortGroups)

This is a new feature for the WebDynpro Table Grouping. Currently only in 710 release.

Parameters:

sortGroups - The sortGroups to set.

getSortGroup

public UWLSortGroup getSortGroup(String name)

This is a new feature for the WebDynpro Table Grouping. Currently only in 710 release.

Parameters:

name -

Returns:

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] UWLJWF	[sap.com] tc/kmc/bc.uwl/api	default	EP-BC-UWL
[sap.com] UWLJWF	[sap.com] tc/kmc/bc.uwl/api	-	EP-BC-UWL