com.sapportals.wcm.control.util.components

Class PropertySelectionModel

java.lang.Object
  extended by com.sapportals.wcm.control.util.components.base.CompositeComponentState
      extended by com.sapportals.wcm.control.util.components.base.ContextModel
          extended by com.sapportals.wcm.control.util.components.PropertySelectionModel
All Implemented Interfaces:
com.sapportals.htmlb.IListModel, com.sapportals.htmlb.table.TableViewModel, IPersistence, Serializable

Deprecated. As of NetWeaver 7.1

public class PropertySelectionModel
extends ContextModel
implements com.sapportals.htmlb.IListModel, com.sapportals.htmlb.table.TableViewModel

See Also:
Serialized Form

Field Summary
static String COLUMN_DEFAULTVALUE
          Deprecated.  
static String COLUMN_DESCRIPTION
          Deprecated.  
static String COLUMN_FULLID
          Deprecated.  
static String COLUMN_ID
          Deprecated.  
static String COLUMN_LABLE
          Deprecated.  
static String COLUMN_NAME
          Deprecated.  
static String COLUMN_NAMESPACE
          Deprecated.  
static String COLUMN_TYPE
          Deprecated.  
 
Method Summary
 com.sapportals.htmlb.table.TableColumn addColumn(String colID)
          Deprecated. As of NetWeaver 7.1
 com.sapportals.wcm.control.util.components.PropertySelectionModel.PropertyItem addEmptyProperty()
          Deprecated. As of NetWeaver 7.1
 void addItem(String propId, String notUsed)
          Deprecated. As of NetWeaver 7.1
 void addKeyColumn(int col)
          Deprecated. As of NetWeaver 7.1
 com.sapportals.wcm.control.util.components.PropertySelectionModel.PropertyItem addProperty(IMetaName impName)
          Deprecated. As of NetWeaver 7.1
 void addSelection(String key)
          Deprecated. As of NetWeaver 7.1
 com.sapportals.htmlb.table.TableColumn getColumn(String colID)
          Deprecated. As of NetWeaver 7.1
 com.sapportals.htmlb.table.TableColumn getColumnAt(int col)
          Deprecated. As of NetWeaver 7.1
 int getColumnCount()
          Deprecated. As of NetWeaver 7.1
 String getColumnName(int col)
          Deprecated. As of NetWeaver 7.1
 Vector getColumns()
          Deprecated. As of NetWeaver 7.1
 String getFilterGroupId()
          Deprecated. As of NetWeaver 7.1
 String getKeyByIndex(int ix)
          Deprecated. As of NetWeaver 7.1
 com.sapportals.htmlb.util.IndexedLinkedList getKeyColumn()
          Deprecated. As of NetWeaver 7.1
 Iterator getKeys()
          Deprecated. As of NetWeaver 7.1
 String[] getMultiSelection()
          Deprecated. As of NetWeaver 7.1
 String getNameOfKeyColumn()
          Deprecated. As of NetWeaver 7.1
 String getNameOfTextColumn()
          Deprecated. As of NetWeaver 7.1
 int getRowCount()
          Deprecated. As of NetWeaver 7.1
 String getSelectedKeys()
          Deprecated. As of NetWeaver 7.1
 IMetaNameList getSelectedProperties()
          Deprecated. As of NetWeaver 7.1
 com.sapportals.htmlb.enums.TableSelectionMode getSelectionMode()
          Deprecated. As of NetWeaver 7.1
 String getSingleSelection()
          Deprecated. As of NetWeaver 7.1
 String getTextByIndex(int ix)
          Deprecated. As of NetWeaver 7.1
 String getTextForKey(String impKey)
          Deprecated. As of NetWeaver 7.1
 com.sapportals.htmlb.type.AbstractDataType getValueAt(int row, int col)
          Deprecated. As of NetWeaver 7.1
 com.sapportals.htmlb.type.AbstractDataType getValueAt(int row, String colID)
          Deprecated. As of NetWeaver 7.1
 void internalInitAfterDeserialization(com.sapportals.htmlb.rendering.IPageContext pc)
          Deprecated. As of NetWeaver 7.1
 boolean invertSelection()
          Deprecated. As of NetWeaver 7.1
 boolean isSelected(int ix)
          Deprecated. As of NetWeaver 7.1
 boolean isSelected(String impKey)
          Deprecated. As of NetWeaver 7.1
 boolean isSingleSelection()
          Deprecated. As of NetWeaver 7.1
 void removeColumn(String colID)
          Deprecated. As of NetWeaver 7.1
 void removeSelection(String key)
          Deprecated. As of NetWeaver 7.1
 void setColumnName(String parm1, int parm2)
          Deprecated. As of NetWeaver 7.1
 void setFilterGroupId(String impFilterGroupID)
          Deprecated. As of NetWeaver 7.1
 void setKeyColumn(int col)
          Deprecated. As of NetWeaver 7.1
 void setNameOfKeyColumn(String parm1)
          Deprecated. As of NetWeaver 7.1
 void setNameOfTextColumn(String parm1)
          Deprecated. As of NetWeaver 7.1
 void setNotSelected()
          Deprecated. As of NetWeaver 7.1
 void setSelectedKeys(String impKeys)
          Deprecated. As of NetWeaver 7.1
 void setSelectedProperties(IMetaNameList selProps)
          Deprecated. As of NetWeaver 7.1
 void setSelection(String key)
          Deprecated. As of NetWeaver 7.1
 void setSelectionMode(com.sapportals.htmlb.enums.TableSelectionMode mode)
          Deprecated. As of NetWeaver 7.1
 boolean setSelectionToAll(boolean select)
          Deprecated. As of NetWeaver 7.1
 void setSingleSelection(boolean single)
          Deprecated. As of NetWeaver 7.1
 void setValueAt(com.sapportals.htmlb.type.AbstractDataType parm1, int parm2, int parm3)
          Deprecated. As of NetWeaver 7.1
 int size()
          Deprecated. As of NetWeaver 7.1
 String toString()
          Deprecated. As of NetWeaver 7.1
 
Methods inherited from class com.sapportals.wcm.control.util.components.base.ContextModel
getContext, getContextFactory, getImagePath, getPersistenceId, getResourceContext, initAfterDeserialization, setContext, setContextFactory, setPersistenceId, setRequest
 
Methods inherited from class com.sapportals.wcm.control.util.components.base.CompositeComponentState
containsKey, containsValue, getProperty, setProperty
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

COLUMN_DESCRIPTION

public static final String COLUMN_DESCRIPTION
Deprecated. 
See Also:
Constant Field Values

COLUMN_TYPE

public static final String COLUMN_TYPE
Deprecated. 
See Also:
Constant Field Values

COLUMN_LABLE

public static final String COLUMN_LABLE
Deprecated. 
See Also:
Constant Field Values

COLUMN_NAME

public static final String COLUMN_NAME
Deprecated. 
See Also:
Constant Field Values

COLUMN_FULLID

public static final String COLUMN_FULLID
Deprecated. 
See Also:
Constant Field Values

COLUMN_ID

public static final String COLUMN_ID
Deprecated. 
See Also:
Constant Field Values

COLUMN_NAMESPACE

public static final String COLUMN_NAMESPACE
Deprecated. 
See Also:
Constant Field Values

COLUMN_DEFAULTVALUE

public static final String COLUMN_DEFAULTVALUE
Deprecated. 
See Also:
Constant Field Values
Method Detail

internalInitAfterDeserialization

public void internalInitAfterDeserialization(com.sapportals.htmlb.rendering.IPageContext pc)
                                      throws DeserializationException
Deprecated. As of NetWeaver 7.1

Specified by:
internalInitAfterDeserialization in class ContextModel
Throws:
DeserializationException

setFilterGroupId

public void setFilterGroupId(String impFilterGroupID)
Deprecated. As of NetWeaver 7.1

Sets the ID of the property group used to filter the properties in the list. Only properties assigned to this group will be contained in the list of selectable properties. If the ID specified is not found, no filter will be used.

Parameters:
impFilterGroupID - The id of the group used as filter

setNameOfKeyColumn

public void setNameOfKeyColumn(String parm1)
Deprecated. As of NetWeaver 7.1

Implementation of IListModel method. not supported here

Specified by:
setNameOfKeyColumn in interface com.sapportals.htmlb.IListModel
Parameters:
parm1 - the name of the key column

setNameOfTextColumn

public void setNameOfTextColumn(String parm1)
Deprecated. As of NetWeaver 7.1

Implementation of IListModel method. not supported here

Specified by:
setNameOfTextColumn in interface com.sapportals.htmlb.IListModel
Parameters:
parm1 - the name of the text column

setSelectionToAll

public boolean setSelectionToAll(boolean select)
Deprecated. As of NetWeaver 7.1

Selects/ deselects all entries in the list. Select all works only in multiselection mode.

Parameters:
select - true to select, false to deselect the entries
Returns:
true if successfully selected/deselected all entries.

invertSelection

public boolean invertSelection()
Deprecated. As of NetWeaver 7.1


setSelection

public void setSelection(String key)
Deprecated. As of NetWeaver 7.1

Implementation of IListModel method.

Specified by:
setSelection in interface com.sapportals.htmlb.IListModel
Parameters:
key - key of the item to select.

setSingleSelection

public void setSingleSelection(boolean single)
Deprecated. As of NetWeaver 7.1

Implementation of IListModel method. Default is false.

Specified by:
setSingleSelection in interface com.sapportals.htmlb.IListModel
Parameters:
single - true to set single selection mode

setSelectedKeys

public void setSelectedKeys(String impKeys)
Deprecated. As of NetWeaver 7.1

Set the selection to the keys specified. A string as returned by getSelectedKeys() is used to restore the selection from a former request.

Parameters:
impKeys - comma separated list with keys as returned from getSelectedKeys

setColumnName

public void setColumnName(String parm1,
                          int parm2)
Deprecated. As of NetWeaver 7.1

Implementation of TableViewModel. not supported here

Specified by:
setColumnName in interface com.sapportals.htmlb.table.TableViewModel
Parameters:
parm1 - not used
parm2 - not used

setValueAt

public void setValueAt(com.sapportals.htmlb.type.AbstractDataType parm1,
                       int parm2,
                       int parm3)
Deprecated. As of NetWeaver 7.1

Implentation of TableViewModel method. Not supported here

Specified by:
setValueAt in interface com.sapportals.htmlb.table.TableViewModel
Parameters:
parm1 - not used
parm2 - not used
parm3 - not used

setKeyColumn

public void setKeyColumn(int col)
Deprecated. As of NetWeaver 7.1

Implentation of TableViewModel method. Not supported here

Specified by:
setKeyColumn in interface com.sapportals.htmlb.table.TableViewModel
Parameters:
col - not used

getFilterGroupId

public String getFilterGroupId()
Deprecated. As of NetWeaver 7.1

returns the Id of the group currently used to filter the properties list.

Returns:
Id of the filter group

getKeyByIndex

public String getKeyByIndex(int ix)
Deprecated. As of NetWeaver 7.1

Implementation of IListModel method. returns the key of the item at the specified index. returns null for wrong index.

Specified by:
getKeyByIndex in interface com.sapportals.htmlb.IListModel
Parameters:
ix - index of an item in the list
Returns:
key of the item specified by the index or null if not found

getTextByIndex

public String getTextByIndex(int ix)
Deprecated. As of NetWeaver 7.1

Implementation of IListModel method. returns the text of the item at the specified index. returns null for wrong index.

Specified by:
getTextByIndex in interface com.sapportals.htmlb.IListModel
Parameters:
ix - index of an item in the list
Returns:
text of the item specified by the index or null if not found

getKeys

public Iterator getKeys()
Deprecated. As of NetWeaver 7.1

Implementation of IListModel method. returns an iterator over all key used in the list

Specified by:
getKeys in interface com.sapportals.htmlb.IListModel
Returns:
iterator which contains all keys in the list

getTextForKey

public String getTextForKey(String impKey)
Deprecated. As of NetWeaver 7.1

Implementation of IListModel method. returns the text of the item with the specified key. returns null if no item with the key specified is found.

Specified by:
getTextForKey in interface com.sapportals.htmlb.IListModel
Parameters:
impKey - key of an item in the list.
Returns:
text of the item

isSelected

public boolean isSelected(int ix)
Deprecated. As of NetWeaver 7.1

Implementation of IListModel method. returns true, if the item with the index specified is selected

Specified by:
isSelected in interface com.sapportals.htmlb.IListModel
Parameters:
ix - index of an item in the list
Returns:
true if item is selected.

isSelected

public boolean isSelected(String impKey)
Deprecated. As of NetWeaver 7.1

Implementation of IListModel method. returns true, if the item with the key specified is selected returns false if no item with the key specified is found.

Specified by:
isSelected in interface com.sapportals.htmlb.IListModel
Parameters:
impKey - key of an item in the list
Returns:
true if item is selected.

getNameOfKeyColumn

public String getNameOfKeyColumn()
Deprecated. As of NetWeaver 7.1

Implementation of IListModel method. returns the name of the column, which containes the keys of the items

Specified by:
getNameOfKeyColumn in interface com.sapportals.htmlb.IListModel
Returns:
language depended string with the key column name

getNameOfTextColumn

public String getNameOfTextColumn()
Deprecated. As of NetWeaver 7.1

Implementation of IListModel method. returns the name of the column, which containes the texts of the items

Specified by:
getNameOfTextColumn in interface com.sapportals.htmlb.IListModel
Returns:
language depended string with the text column name

setSelectionMode

public void setSelectionMode(com.sapportals.htmlb.enums.TableSelectionMode mode)
Deprecated. As of NetWeaver 7.1


getSelectionMode

public com.sapportals.htmlb.enums.TableSelectionMode getSelectionMode()
Deprecated. As of NetWeaver 7.1


isSingleSelection

public boolean isSingleSelection()
Deprecated. As of NetWeaver 7.1

Implementation of IListModel method. returns true if the model is in single selections mode

Specified by:
isSingleSelection in interface com.sapportals.htmlb.IListModel
Returns:
true if single selection mode is active

getSingleSelection

public String getSingleSelection()
Deprecated. As of NetWeaver 7.1

Implementation of IListModel method. returns the key of the item which is selected. In multiselection mode, the first selected item is returned

Specified by:
getSingleSelection in interface com.sapportals.htmlb.IListModel
Returns:
the selected items key

getMultiSelection

public String[] getMultiSelection()
Deprecated. As of NetWeaver 7.1

Implementation of IListModel method. returns an array with the keys of the selected items.

Specified by:
getMultiSelection in interface com.sapportals.htmlb.IListModel
Returns:
the keys of the selected items

getSelectedKeys

public String getSelectedKeys()
Deprecated. As of NetWeaver 7.1

method used to persist the selection state of the list. returns a comma separated list of with the keys of all selected items. To restore the selection state, use setSelectedKeys

Returns:
all selected keys

getSelectedProperties

public IMetaNameList getSelectedProperties()
Deprecated. As of NetWeaver 7.1

Get the SelectedProperties attribute of the PropertiesModel object.

Returns:
The SelectedProperties value

setSelectedProperties

public void setSelectedProperties(IMetaNameList selProps)
Deprecated. As of NetWeaver 7.1


getRowCount

public int getRowCount()
Deprecated. As of NetWeaver 7.1

Implementation of TableViewModel method. Returns the number of rows, contained in the model

Specified by:
getRowCount in interface com.sapportals.htmlb.table.TableViewModel
Returns:
number of rows of the model

getColumnCount

public int getColumnCount()
Deprecated. As of NetWeaver 7.1

Implementation of TableViewModel method. returns the number of shown columns.

Specified by:
getColumnCount in interface com.sapportals.htmlb.table.TableViewModel
Returns:
number of shown columns.

getColumnName

public String getColumnName(int col)
Deprecated. As of NetWeaver 7.1

Implementation of TableViewModel method. returns the identifier of the column with the specified index

Specified by:
getColumnName in interface com.sapportals.htmlb.table.TableViewModel
Parameters:
col - index of a column
Returns:
id of the column

getValueAt

public com.sapportals.htmlb.type.AbstractDataType getValueAt(int row,
                                                             int col)
Deprecated. As of NetWeaver 7.1

Implementation of TableViewModel method. returns the value of a table cell

Specified by:
getValueAt in interface com.sapportals.htmlb.table.TableViewModel
Parameters:
row - row of the table cell
col - column of the table cell
Returns:
value of the table cell

getValueAt

public com.sapportals.htmlb.type.AbstractDataType getValueAt(int row,
                                                             String colID)
Deprecated. As of NetWeaver 7.1

Implementation of TableViewModel method. returns the value of a table cell

Specified by:
getValueAt in interface com.sapportals.htmlb.table.TableViewModel
Parameters:
row - row of the table cell
colID - column of the table cell
Returns:
value of the table cell

getKeyColumn

public com.sapportals.htmlb.util.IndexedLinkedList getKeyColumn()
Deprecated. As of NetWeaver 7.1

Implementation of TableViewModel method. a column with the keys of all items in the list

Specified by:
getKeyColumn in interface com.sapportals.htmlb.table.TableViewModel
Returns:
the keys of all items in the list

getColumns

public Vector getColumns()
Deprecated. As of NetWeaver 7.1

Implementation of TableViewModel method. A vector containing TableColumn Objects with all visible columns of the table.

Specified by:
getColumns in interface com.sapportals.htmlb.table.TableViewModel
Returns:
The columns of the table

getColumn

public com.sapportals.htmlb.table.TableColumn getColumn(String colID)
Deprecated. As of NetWeaver 7.1

Implementation of TableViewModel method. The TableColumn object of the column with the id specified.

Parameters:
colID - id of a column
Returns:
The column

getColumnAt

public com.sapportals.htmlb.table.TableColumn getColumnAt(int col)
Deprecated. As of NetWeaver 7.1

Implementation of TableViewModel method. The TableColumn object of the column with the index specified.

Specified by:
getColumnAt in interface com.sapportals.htmlb.table.TableViewModel
Parameters:
colID - index of a column
Returns:
The column

addEmptyProperty

public com.sapportals.wcm.control.util.components.PropertySelectionModel.PropertyItem addEmptyProperty()
Deprecated. As of NetWeaver 7.1


setNotSelected

public void setNotSelected()
Deprecated. As of NetWeaver 7.1


addProperty

public com.sapportals.wcm.control.util.components.PropertySelectionModel.PropertyItem addProperty(IMetaName impName)
Deprecated. As of NetWeaver 7.1

Add Property to the PropertiesModel object.

Parameters:
impName - Property to be added
Returns:
@todo: Description of the outgoing return value

addItem

public void addItem(String propId,
                    String notUsed)
Deprecated. As of NetWeaver 7.1

Implementation of IListModel method adds an item to the list. The new item is a property with the id specified. If the property is found, the item is added to the list.

Specified by:
addItem in interface com.sapportals.htmlb.IListModel
Parameters:
propId - id of the property
notUsed - not used

size

public int size()
Deprecated. As of NetWeaver 7.1

Implementation of IListModel method The number of entries in the list.

Specified by:
size in interface com.sapportals.htmlb.IListModel
Returns:
The number of entries in the list.

addSelection

public void addSelection(String key)
Deprecated. As of NetWeaver 7.1

Implementation of IListModel method. Set item with the key specified selected.

Specified by:
addSelection in interface com.sapportals.htmlb.IListModel
Parameters:
key - item to be selected

removeSelection

public void removeSelection(String key)
Deprecated. As of NetWeaver 7.1

Implementation of IListModel method. Set item with the key specified deselected.

Specified by:
removeSelection in interface com.sapportals.htmlb.IListModel
Parameters:
key - item to be deselected

addKeyColumn

public void addKeyColumn(int col)
Deprecated. As of NetWeaver 7.1

Implementation of TableViewModel method. not supported here

Specified by:
addKeyColumn in interface com.sapportals.htmlb.table.TableViewModel
Parameters:
col - index of column

addColumn

public com.sapportals.htmlb.table.TableColumn addColumn(String colID)
Deprecated. As of NetWeaver 7.1

Implementation of TableViewModel method. adds the column with the id specified to the visible columns in the table.

Specified by:
addColumn in interface com.sapportals.htmlb.table.TableViewModel
Parameters:
colID - id of a column
Returns:
the added column, null if no column for the id specified was found.

removeColumn

public void removeColumn(String colID)
Deprecated. As of NetWeaver 7.1

Implementation of TableViewModel method. removes the column with the id specified from the visible columns in the table.

Specified by:
removeColumn in interface com.sapportals.htmlb.table.TableViewModel
Parameters:
colID - id of a column

toString

public String toString()
Deprecated. As of NetWeaver 7.1

returns a comma separated string of all keys contained in the model

Overrides:
toString in class Object
Returns:
all keys in the model
Access Rights

This class can be accessed from:


SC DC Public Part ACH
[sap.com] KMC-CM [sap.com] tc/km/nonwduideprecated api EP-KM-CM
[sap.com] KMC-WPC [sap.com] tc/kmc/wpc/wpcfacade api EP-PIN-WPC-WCM


Copyright 2011 SAP AG Complete Copyright Notice