PropertyColumnFactory

java.lang.Object
- com.sapportals.wcm.control.util.property.PropertyColumnFactory

All Implemented Interfaces:: com.sapportals.config.event.IConfigEventListener, EventListener

public class PropertyColumnFactory
extends Object
implements com.sapportals.config.event.IConfigEventListener

Field Summary

Fields
Modifier and Type	Field and Description
`static com.sapportals.htmlb.enums.CellVAlign`	`DEFAULT_VALIGN`
`static String`	`END_MODIFIER_LIST`
`static String`	`END_POSITION_MODIFIER`
`static String`	`MODIFIER_SEPARATOR`
`static String`	`PROPERTY_COLUMN_SEPARATOR`
`static String`	`PROPERTY_DIFFRENT_LINES`
`static String`	`PROPERTY_SAME_LINE`
`static String`	`SEPARATOR_PADDING`
`static String`	`SEPARATOR_POSITION`
`static String`	`SEPARATOR_SAME_POSITION`
`static String`	`START_MODIFIER_LIST`
`static String`	`START_POSITION_MODIFIER`
`static String[]`	`validFlexUIModifiersNames`
`static String[]`	`validSearchModifiersNames`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ArrayList`	`checkInvalidMetaNames(String propertyColumnString)` Check if the inputed modifiers are valid
`ArrayList`	`checkInvalidModifiers(String propertyColumnString)` Check if the inputed modifiers are valid
`void`	`configEvent(com.sapportals.config.event.ConfigEvent parm1)` is called by the configuration, if configuration for the factory was changed.
`boolean`	`containsMetaName(IPropertyColumn[] propertyColumns, String metaNameID)` Checks if the IPropertyColumn[] contains a certain IMetaName id
`boolean`	`containsMetaName(IPropertyColumn propertyColumn, String metaNameID)` Checks if the IPropertyColumn contains a certain IMetaName id
`String`	`getColumnPropertyString(IPropertyColumn[] columns)` returns a string with all columns and properties as needed for the rndPropertyColumns parameter whithin the rendering
`String`	`getColumnString(IPropertyColumn column)` returns the string representation of a single column.
`String`	`getConfigListenerId()` Gets the configListenerId attribute of the UICommandFactory object
`com.sapportals.htmlb.enums.CellHAlign`	`getHAlign(IPropertyColumn propertyColumn)` Gets the hAlign attribute of the PropertyColumnFactory object
`static PropertyColumnFactory`	`getInstance()`
`static PropertyColumnFactory`	`getInstance(PropertyColumnType propertyColumnType)`
`IPropertyModifier`	`getModifierByName(IPropertyColumn propertyColumn, String modifierName, IMetaName metaName)` Gets the property modifier for a given name from the Property Column If IMetaName is null than it takes the first found modifier
`IPropertyModifierList`	`getModifierList(String columnString)`
`IPropertyModifierList`	`getModifierList(String columnString, String mod_separator)`
`Hashtable`	`getModifiersAsHashtable(String modifiersStr)`
`String`	`getModifierString(IPropertyModifierList modifierList)` returns a string representing all modifiers contained in the specified array.
`String`	`getModifierString(IPropertyModifierList modifierList, String start_modifier_list, String end_modifier_list, String modifier_separator)` returns a string representing all modifiers contained in the specified array.
`String`	`getModifierValue(IPropertyColumn propertyColumn, IMetaName metaName, String modifierName)`
`static int`	`getNoOfColumn(IPropertyColumn[] iterColumns, int defaultNo)` Returns the number of columns for a given IPropertyColumn[]
`int[]`	`getPaddingsValues(IPropertyColumn propertyColumn, IMetaName metaName)` Gets the padding values for a given IMetaName from the Property Column
`IPropertyPosition`	`getPosition(IPropertyColumn propertyColumn)` Gets the position attribute of the PropertyColumnFactory object
`IPropertyColumn`	`getPropertyColum(IPropertyWithModifiersList propertyModifierList, String[] separator)` Gets the propertyColum attribute of the PropertyColumnFactory object
`IPropertyColumn`	`getPropertyColumn(String columnString)` Gets the propertyColumn attribute of the PropertyColumnFactory object
`IPropertyModifier`	`getPropertyModifier(String key)` Gets the propertyModifier attribute of the PropertyColumnFactory object
`IPropertyNameList`	`getPropertyNameList(IPropertyColumn[] propertyColumn)` Parse the propertyColumn searching all the MetaNames and return a list with Property Names provived this MetaNames In additional, property name for the Meta Name with ID rnd:contentLink is included in the list;
`IPropertyPaddingModifier`	`getPropertyPaddingModifier(String key, int padding)` Gets the propertyModifier attribute of the PropertyColumnFactory object
`IPropertyPosition`	`getPropertyPosition(int row, int spanRow, int column, int spanColumn)` Gets the propertyModifier attribute of the PropertyColumnFactory object
`IPropertyModifier`	`getPropertyPositionModifier(int row, int spanRow, int column, int spanColumn)` Gets the propertyModifier attribute of the PropertyColumnFactory object
`String`	`getPropertyPositionString(IPropertyPositionModifier mod)`
`String`	`getPropertyString(IPropertyWithModifiers prop)` returns a String representation of a property with its modifiers.
`IPropertyWithModifiers`	`getPropertyWithModifier(String columnString)` Gets the propertyWithModifier attribute of the PropertyColumnFactory object
`IPropertyWithModifiers`	`getPropertyWithModifiers(IMetaName metaName, IPropertyModifierList propertyModifierList)` Gets the propertyWithModifiers attribute of the PropertyColumnFactory object
`IStringValueModifier`	`getStringValueModifier(String name, String value)`
`String[]`	`getValidModifierNames()`
`com.sapportals.htmlb.enums.CellVAlign`	`getVAlign(IPropertyColumn propertyColumn)` Gets the hAlign attribute of the PropertyColumnFactory object
`IPropertyModifierList`	`newPropertyModifierList()` Description of the Method
`IPropertyWithModifiersList`	`newPropertyWithModifiersList()` Description of the Method
`IPropertyColumn[]`	`parseProperty(String propertyColumnString)` Description of the Method

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PROPERTY_SAME_LINE
```
public static final String PROPERTY_SAME_LINE
```
    See Also:
    
    Constant Field Values
  - PROPERTY_DIFFRENT_LINES
```
public static final String PROPERTY_DIFFRENT_LINES
```
    See Also:
    
    Constant Field Values
  - PROPERTY_COLUMN_SEPARATOR
```
public static final String PROPERTY_COLUMN_SEPARATOR
```
    See Also:
    
    Constant Field Values
  - START_MODIFIER_LIST
```
public static final String START_MODIFIER_LIST
```
    See Also:
    
    Constant Field Values
  - END_MODIFIER_LIST
```
public static final String END_MODIFIER_LIST
```
    See Also:
    
    Constant Field Values
  - MODIFIER_SEPARATOR
```
public static final String MODIFIER_SEPARATOR
```
    See Also:
    
    Constant Field Values
  - DEFAULT_VALIGN
```
public static final com.sapportals.htmlb.enums.CellVAlign DEFAULT_VALIGN
```
  - START_POSITION_MODIFIER
```
public static final String START_POSITION_MODIFIER
```
    See Also:
    
    Constant Field Values
  - END_POSITION_MODIFIER
```
public static final String END_POSITION_MODIFIER
```
    See Also:
    
    Constant Field Values
  - SEPARATOR_SAME_POSITION
```
public static final String SEPARATOR_SAME_POSITION
```
    See Also:
    
    Constant Field Values
  - SEPARATOR_POSITION
```
public static final String SEPARATOR_POSITION
```
    See Also:
    
    Constant Field Values
  - SEPARATOR_PADDING
```
public static final String SEPARATOR_PADDING
```
    See Also:
    
    Constant Field Values
  - validFlexUIModifiersNames
```
public static final String[] validFlexUIModifiersNames
```
  - validSearchModifiersNames
```
public static final String[] validSearchModifiersNames
```
- Method Detail
  - getInstance
```
public static PropertyColumnFactory getInstance()
```
    Returns:
    
    An instance of this class of corresponding to a configManager.
  - getInstance
```
public static PropertyColumnFactory getInstance(PropertyColumnType propertyColumnType)
```
    Returns:
    
    An instance of this class of corresponding to a configManager.
  - parseProperty
```
public IPropertyColumn[] parseProperty(String propertyColumnString)
```
    Description of the Method
    
    Parameters:
    
    propertyColumnString - Description of the param
    
    Returns:
    
    Description of the Return Value
  - getPosition
```
public IPropertyPosition getPosition(IPropertyColumn propertyColumn)
```
    Gets the position attribute of the PropertyColumnFactory object
    
    Parameters:
    
    propertyColumn - Description of the param
    
    Returns:
    
    The position value
  - getModifierByName
```
public IPropertyModifier getModifierByName(IPropertyColumn propertyColumn,
                                           String modifierName,
                                           IMetaName metaName)
```
    Gets the property modifier for a given name from the Property Column If IMetaName is null than it takes the first found modifier
    
    Parameters:
    
    propertyColumn - Description of the param
    
    modifierName - Modifier Name
    
    metaName - Description of the Parameter
    
    Returns:
    
    The position value
  - getPaddingsValues
```
public int[] getPaddingsValues(IPropertyColumn propertyColumn,
                               IMetaName metaName)
```
    Gets the padding values for a given IMetaName from the Property Column
    
    Parameters:
    
    propertyColumn - Description of the param
    
    metaName - Description of the Parameter
    
    Returns:
    
    The position value
  - getModifierValue
```
public String getModifierValue(IPropertyColumn propertyColumn,
                               IMetaName metaName,
                               String modifierName)
```
  - getHAlign
```
public com.sapportals.htmlb.enums.CellHAlign getHAlign(IPropertyColumn propertyColumn)
```
    Gets the hAlign attribute of the PropertyColumnFactory object
    
    Parameters:
    
    propertyColumn - Description of the param
    
    Returns:
    
    The hAlign value
  - containsMetaName
```
public boolean containsMetaName(IPropertyColumn[] propertyColumns,
                                String metaNameID)
```
    Checks if the IPropertyColumn[] contains a certain IMetaName id
    
    Parameters:
    
    propertyColumns - Description of the param
    
    metaNameID -
    
    Returns:
    
    The hAlign value
  - containsMetaName
```
public boolean containsMetaName(IPropertyColumn propertyColumn,
                                String metaNameID)
```
    Checks if the IPropertyColumn contains a certain IMetaName id
    
    Parameters:
    
    propertyColumn - Description of the param
    
    Returns:
    
    The hAlign value
  - getVAlign
```
public com.sapportals.htmlb.enums.CellVAlign getVAlign(IPropertyColumn propertyColumn)
```
    Gets the hAlign attribute of the PropertyColumnFactory object
    
    Parameters:
    
    propertyColumn - Description of the param
    
    Returns:
    
    The hAlign value
  - getColumnPropertyString
```
public String getColumnPropertyString(IPropertyColumn[] columns)
```
    returns a string with all columns and properties as needed for the rndPropertyColumns parameter whithin the rendering
    
    Parameters:
    
    columns - Description of the param
    
    Returns:
    
    The columnPropertyString value
  - getPropertyColumn
```
public IPropertyColumn getPropertyColumn(String columnString)
```
    Gets the propertyColumn attribute of the PropertyColumnFactory object
    
    Parameters:
    
    columnString - Description of the param
    
    Returns:
    
    The propertyColumn value
  - getColumnString
```
public String getColumnString(IPropertyColumn column)
```
    returns the string representation of a single column. Opposite of getPropertyColumn(String)
    
    Parameters:
    
    column - Description of the param
    
    Returns:
    
    The columnString value
  - getPropertyWithModifier
```
public IPropertyWithModifiers getPropertyWithModifier(String columnString)
```
    Gets the propertyWithModifier attribute of the PropertyColumnFactory object
    
    Parameters:
    
    columnString - Description of the param
    
    Returns:
    
    The propertyWithModifier value
  - getPropertyString
```
public String getPropertyString(IPropertyWithModifiers prop)
```
    returns a String representation of a property with its modifiers. Opposite of getPropertyWithModifier(String)
    
    Parameters:
    
    prop - Description of the param
    
    Returns:
    
    The propertyString value
  - getModifierList
```
public IPropertyModifierList getModifierList(String columnString)
```
  - getModifierList
```
public IPropertyModifierList getModifierList(String columnString,
                                             String mod_separator)
```
  - getModifiersAsHashtable
```
public Hashtable getModifiersAsHashtable(String modifiersStr)
```
  - getPropertyPositionString
```
public String getPropertyPositionString(IPropertyPositionModifier mod)
```
  - getModifierString
```
public String getModifierString(IPropertyModifierList modifierList)
```
    returns a string representing all modifiers contained in the specified array. Opposite to getModifierList(String)
    
    Parameters:
    
    modifierList - Description of the param
    
    Returns:
    
    The modifierString value
  - getModifierString
```
public String getModifierString(IPropertyModifierList modifierList,
                                String start_modifier_list,
                                String end_modifier_list,
                                String modifier_separator)
```
    returns a string representing all modifiers contained in the specified array. Opposite to getModifierList(String)
    
    Parameters:
    
    modifierList - Description of the param
    
    start_modifier_list - Description of the Parameter
    
    end_modifier_list - Description of the Parameter
    
    modifier_separator - Description of the Parameter
    
    Returns:
    
    The modifierString value
  - getPropertyModifier
```
public IPropertyModifier getPropertyModifier(String key)
```
    Gets the propertyModifier attribute of the PropertyColumnFactory object
    
    Parameters:
    
    key - Description of the param
    
    Returns:
    
    The propertyModifier value
  - getPropertyPositionModifier
```
public IPropertyModifier getPropertyPositionModifier(int row,
                                                     int spanRow,
                                                     int column,
                                                     int spanColumn)
```
    Gets the propertyModifier attribute of the PropertyColumnFactory object
    
    Parameters:
    
    row - Description of the param
    
    spanRow - Description of the param
    
    column - Description of the param
    
    spanColumn - Description of the param
    
    Returns:
    
    The propertyModifier value
  - getPropertyPaddingModifier
```
public IPropertyPaddingModifier getPropertyPaddingModifier(String key,
                                                           int padding)
```
    Gets the propertyModifier attribute of the PropertyColumnFactory object
    
    Parameters:
    
    key - Description of the param
    
    padding - Description of the Parameter
    
    Returns:
    
    The propertyModifier value
  - getStringValueModifier
```
public IStringValueModifier getStringValueModifier(String name,
                                                   String value)
```
  - getValidModifierNames
```
public String[] getValidModifierNames()
```
  - getPropertyPosition
```
public IPropertyPosition getPropertyPosition(int row,
                                             int spanRow,
                                             int column,
                                             int spanColumn)
```
    Gets the propertyModifier attribute of the PropertyColumnFactory object
    
    Parameters:
    
    row - Description of the param
    
    spanRow - Description of the param
    
    column - Description of the param
    
    spanColumn - Description of the param
    
    Returns:
    
    The propertyModifier value
  - getPropertyWithModifiers
```
public IPropertyWithModifiers getPropertyWithModifiers(IMetaName metaName,
                                                       IPropertyModifierList propertyModifierList)
```
    Gets the propertyWithModifiers attribute of the PropertyColumnFactory object
    
    Parameters:
    
    metaName - Description of the param
    
    propertyModifierList - Description of the param
    
    Returns:
    
    The propertyWithModifiers value
  - newPropertyWithModifiersList
```
public IPropertyWithModifiersList newPropertyWithModifiersList()
```
    Description of the Method
    
    Returns:
    
    Description of the Return Value
  - newPropertyModifierList
```
public IPropertyModifierList newPropertyModifierList()
```
    Description of the Method
    
    Returns:
    
    Description of the Return Value
  - getPropertyColum
```
public IPropertyColumn getPropertyColum(IPropertyWithModifiersList propertyModifierList,
                                        String[] separator)
```
    Gets the propertyColum attribute of the PropertyColumnFactory object
    
    Parameters:
    
    propertyModifierList - Description of the param
    
    separator - Description of the param
    
    Returns:
    
    The propertyColum value
  - getPropertyNameList
```
public IPropertyNameList getPropertyNameList(IPropertyColumn[] propertyColumn)
```
    Parse the propertyColumn searching all the MetaNames and return a list with Property Names provived this MetaNames In additional, property name for the Meta Name with ID rnd:contentLink is included in the list;
    
    Parameters:
    
    propertyColumn - Description of the param
    
    Returns:
    
    The propertyNameList value
  - getNoOfColumn
```
public static int getNoOfColumn(IPropertyColumn[] iterColumns,
                                int defaultNo)
```
    Returns the number of columns for a given IPropertyColumn[]
    
    Parameters:
    
    iterColumns - Description of the Parameter
    
    defaultNo - Description of the Parameter
    
    Returns:
    
    The noOfColumn value
  - checkInvalidModifiers
```
public ArrayList checkInvalidModifiers(String propertyColumnString)
```
    Check if the inputed modifiers are valid
    
    Parameters:
    
    propertyColumnString - Description of the param
    
    Returns:
    
    Description of the Return Value
  - checkInvalidMetaNames
```
public ArrayList checkInvalidMetaNames(String propertyColumnString)
```
    Check if the inputed modifiers are valid
    
    Parameters:
    
    propertyColumnString - Description of the param
    
    Returns:
    
    Description of the Return Value
  - configEvent
```
public void configEvent(com.sapportals.config.event.ConfigEvent parm1)
```
    is called by the configuration, if configuration for the factory was changed. If the event is of type ConfigEvent.CONFIGURABLE_LOADED or ConfigEvent.CONFIGMANAGER_TERMINATED, the factory deletes all its entries and reloads the configuration, creating all commands anew.
    
    Specified by:
    
    configEvent in interface com.sapportals.config.event.IConfigEventListener
    
    Parameters:
    
    parm1 - the event raised by the configuration
  - getConfigListenerId
```
public String getConfigListenerId()
```
    Gets the configListenerId attribute of the UICommandFactory object
    
    Specified by:
    
    getConfigListenerId in interface com.sapportals.config.event.IConfigEventListener
    
    Returns:
    
    The configListenerId value

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`

Class PropertyColumnFactory

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROPERTY_SAME_LINE

PROPERTY_DIFFRENT_LINES

PROPERTY_COLUMN_SEPARATOR

START_MODIFIER_LIST

END_MODIFIER_LIST

MODIFIER_SEPARATOR

DEFAULT_VALIGN

START_POSITION_MODIFIER

END_POSITION_MODIFIER

SEPARATOR_SAME_POSITION

SEPARATOR_POSITION

SEPARATOR_PADDING

validFlexUIModifiersNames

validSearchModifiersNames

Method Detail

getInstance

getInstance

parseProperty

getPosition

getModifierByName

getPaddingsValues

getModifierValue

getHAlign

containsMetaName

containsMetaName

getVAlign

getColumnPropertyString

getPropertyColumn

getColumnString

getPropertyWithModifier

getPropertyString

getModifierList

getModifierList

getModifiersAsHashtable

getPropertyPositionString

getModifierString

getModifierString

getPropertyModifier

getPropertyPositionModifier

getPropertyPaddingModifier

getStringValueModifier

getValidModifierNames

getPropertyPosition

getPropertyWithModifiers

newPropertyWithModifiersList

newPropertyModifierList

getPropertyColum

getPropertyNameList

getNoOfColumn

checkInvalidModifiers

checkInvalidMetaNames

configEvent

getConfigListenerId

This class can be accessed from: