Web Dynpro API Documentation

com.sap.tc.webdynpro.clientserver.uielib.standard.api
Class WDTextWrapping

java.lang.Object
  |
  +--com.sap.tc.webdynpro.clientserver.uielib.standard.api.WDTextWrapping

public final class WDTextWrapping
extends java.lang.Object

Enumeration type WDTextWrapping. Defines the text wrapping values.

This type can be called by applications using Web Dynpro, but DO NOT EXTEND IT!


Field Summary
static WDTextWrapping HARD
          Wraps the text if the value specified by the col property is reached.
static WDTextWrapping OFF
          The text is not wrapped.
static WDTextWrapping SOFT
          Wraps the text if the value specified by the col attribute is reached.
 
Method Summary
static java.util.Iterator iterateValues()
          Returns an iterator over the values of the WDTextWrapping type.
 int ordinal()
          Returns the ordinal of this enumeration value (its position in its enum declaration, where the first value is assigned an ordinal of zero).
 java.lang.String toString()
          Returns the string representation of this enumeration value.
static WDTextWrapping valueOf(int ordinal)
          Returns the enumeration value for the given ordinal.
static WDTextWrapping valueOf(java.lang.String name)
          Returns the enumeration value for the given name.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

OFF

public static final WDTextWrapping OFF
The text is not wrapped. If the text row length exceeds the width specified by the col property, a horizontal scroll bar is displayed.

HARD

public static final WDTextWrapping HARD
Wraps the text if the value specified by the col property is reached. A carriage control is inserted for each wrapping. A horizontal scroll bar is not displayed for this value.

SOFT

public static final WDTextWrapping SOFT
Wraps the text if the value specified by the col attribute is reached. A carriage control is not inserted for the wrapping, and a horizontal scroll bar is not displayed for this value.
Method Detail

ordinal

public int ordinal()
Returns the ordinal of this enumeration value (its position in its enum declaration, where the first value is assigned an ordinal of zero). Most programmers will have no use for this method. It is designed for use by sophisticated enum-based data structures.
Returns:
the ordinal of this enumeration value

toString

public java.lang.String toString()
Returns the string representation of this enumeration value.
Overrides:
toString in class java.lang.Object
Returns:
the string value of this enumeration value

valueOf

public static WDTextWrapping valueOf(int ordinal)
Returns the enumeration value for the given ordinal.
Parameters:
ordinal - an ordinal
Returns:
the enumeration value for the given ordinal

valueOf

public static WDTextWrapping valueOf(java.lang.String name)
Returns the enumeration value for the given name. Ignores case.
Parameters:
name - a name
Returns:
the enumeration value for the given name

iterateValues

public static java.util.Iterator iterateValues()
Returns an iterator over the values of the WDTextWrapping type.
Returns:
a read-only iterator over the values of this enumeration type

Web Dynpro API Documentation

Copyright © 2004 SAP AG. Automatically generated Thu Mar 3 2005, 22:15