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

Interface IWDHorizontalGutter

All Superinterfaces:

IWDUIElement, IWDViewElement

public interface IWDHorizontalGutter

extends IWDUIElement

Web Dynpro HorizontalGutter API. The HorizontalGutter UI element helps you to structure the layout and the text parts of Web Dynpro screen, similar to the HTML tag <hr>. You use it to insert additional, vertical spaces between UI elements and to group together elements and texts that belong together

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

Type Classification:

This interface is part of the Web Dynpro API, so applications may reference it or call any method of it, but they must not implement or extend it.

For a detailed explanation of API classification see the Web Dynpro Compatibility Guide

Field Summary

static boolean	DEFAULT_HAS_RULE Default value of the hasRule property is true.
static WDHorizontalDividerRuleHeight	DEFAULT_HEIGHT Default value of the height property is WDHorizontalDividerRuleHeight.MEDIUM.
static WDHorizontalGutterRuleType	DEFAULT_RULE_TYPE Default value of the ruleType property is WDHorizontalGutterRuleType.AREA_RULE.
static String	DEFAULT_WIDTH Default value of the width property is "100%".

Fields inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDUIElement

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

void	bindHasRule(IWDAttributeInfo attributeInfo) Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Use attribute ruleType instead. DisplayType=none is equivalent to hasRule=false and displayType=areaRule is equivalent to hasRule=true.
void	bindHasRule(String path) Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Use attribute ruleType instead. DisplayType=none is equivalent to hasRule=false and displayType=areaRule is equivalent to hasRule=true.
void	bindHeight(IWDAttributeInfo attributeInfo) Binds the height property to the context attribute specified by the given attribute info.
void	bindHeight(String path) Binds the height property to the context attribute specified by the given path.
String	bindingOfHasRule() Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Use attribute ruleType instead. DisplayType=none is equivalent to hasRule=false and displayType=areaRule is equivalent to hasRule=true.
String	bindingOfHeight() Returns the binding path of the height property.
String	bindingOfRuleType() Returns the binding path of the ruleType property.
String	bindingOfWidth() Returns the binding path of the width property.
void	bindRuleType(IWDAttributeInfo attributeInfo) Binds the ruleType property to the context attribute specified by the given attribute info.
void	bindRuleType(String path) Binds the ruleType property to the context attribute specified by the given path.
void	bindWidth(IWDAttributeInfo attributeInfo) Binds the width property to the context attribute specified by the given attribute info.
void	bindWidth(String path) Binds the width property to the context attribute specified by the given path.
boolean	getHasRule() Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Use attribute ruleType instead. DisplayType=none is equivalent to hasRule=false and displayType=areaRule is equivalent to hasRule=true.
WDHorizontalDividerRuleHeight	getHeight() Returns the value of the height property.
WDHorizontalGutterRuleType	getRuleType() Returns the value of the ruleType property.
String	getWidth() Returns the value of the width property.
void	setHasRule(boolean value) Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Use attribute ruleType instead. DisplayType=none is equivalent to hasRule=false and displayType=areaRule is equivalent to hasRule=true.
void	setHeight(WDHorizontalDividerRuleHeight value) Sets the height property to the given value.
void	setRuleType(WDHorizontalGutterRuleType value) Sets the ruleType property to the given value.
void	setWidth(String value) Sets the width property to the given value.

Methods inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDUIElement

bindEnabled, bindEnabled, bindingOfEnabled, bindingOfTooltip, bindingOfVisible, bindTooltip, bindTooltip, bindVisible, bindVisible, createLayoutData, getContainer, getEnabled, getLayoutData, getTooltip, getVisible, setEnabled, setTooltip, setVisible

Methods inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDViewElement

destroy, getId, getView, requestFocus

Field Detail

DEFAULT_HAS_RULE

public static final boolean DEFAULT_HAS_RULE

Default value of the hasRule property is true.

See Also:

Constant Field Values

DEFAULT_HEIGHT

public static final WDHorizontalDividerRuleHeight DEFAULT_HEIGHT

Default value of the height property is WDHorizontalDividerRuleHeight.MEDIUM.

DEFAULT_RULE_TYPE

public static final WDHorizontalGutterRuleType DEFAULT_RULE_TYPE

Default value of the ruleType property is WDHorizontalGutterRuleType.AREA_RULE.

DEFAULT_WIDTH

public static final String DEFAULT_WIDTH

Default value of the width property is "100%".

See Also:

Constant Field Values

Method Detail

bindHasRule

public void bindHasRule(String path)

Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Use attribute ruleType instead. DisplayType=none is equivalent to hasRule=false and displayType=areaRule is equivalent to hasRule=true.

Binds the hasRule property to the context attribute specified by the given path.

Parameters:

path - the context path of the attribute to which the hasRule property will be bound

bindHasRule

public void bindHasRule(IWDAttributeInfo attributeInfo)

Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Use attribute ruleType instead. DisplayType=none is equivalent to hasRule=false and displayType=areaRule is equivalent to hasRule=true.

Binds the hasRule property to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the hasRule property will be bound

bindingOfHasRule

public String bindingOfHasRule()

Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Use attribute ruleType instead. DisplayType=none is equivalent to hasRule=false and displayType=areaRule is equivalent to hasRule=true.

Returns the binding path of the hasRule property.

Returns:

the path of the context attribute to which the hasRule property is currently bound

getHasRule

public boolean getHasRule()

Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Use attribute ruleType instead. DisplayType=none is equivalent to hasRule=false and displayType=areaRule is equivalent to hasRule=true.

Returns the value of the hasRule property.

The initial value is true.

Specifies whether the UI element is displayed with a line.

Returns:

the current value of the hasRule property

See Also:

setHasRule(boolean)

setHasRule

public void setHasRule(boolean value)

Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Use attribute ruleType instead. DisplayType=none is equivalent to hasRule=false and displayType=areaRule is equivalent to hasRule=true.

Sets the hasRule property to the given value.

Parameters:

value - the new value of the hasRule property

See Also:

getHasRule()

bindHeight

public void bindHeight(String path)

Binds the height property to the context attribute specified by the given path.

Parameters:

path - the context path of the attribute to which the height property will be bound

bindHeight

public void bindHeight(IWDAttributeInfo attributeInfo)

Binds the height property to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the height property will be bound

bindingOfHeight

public String bindingOfHeight()

Returns the binding path of the height property.

Returns:

the path of the context attribute to which the height property is currently bound

getHeight

public WDHorizontalDividerRuleHeight getHeight()

Returns the value of the height property.

The initial value is WDHorizontalDividerRuleHeight.MEDIUM.

Specifies the height of the HorizontalGutter UI element.

Returns:

the current value of the height property

See Also:

setHeight(WDHorizontalDividerRuleHeight)

setHeight

public void setHeight(WDHorizontalDividerRuleHeight value)

Sets the height property to the given value.

Parameters:

value - the new value of the height property

See Also:

getHeight()

bindRuleType

public void bindRuleType(String path)

Binds the ruleType property to the context attribute specified by the given path.

Parameters:

path - the context path of the attribute to which the ruleType property will be bound

bindRuleType

public void bindRuleType(IWDAttributeInfo attributeInfo)

Binds the ruleType property to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the ruleType property will be bound

bindingOfRuleType

public String bindingOfRuleType()

Returns the binding path of the ruleType property.

Returns:

the path of the context attribute to which the ruleType property is currently bound

getRuleType

public WDHorizontalGutterRuleType getRuleType()

Returns the value of the ruleType property.

The initial value is WDHorizontalGutterRuleType.AREA_RULE.

Specifies whether the UI element is displayed with a rule and determines the visual appearance of this rule.

Returns:

the current value of the ruleType property

See Also:

setRuleType(WDHorizontalGutterRuleType)

setRuleType

public void setRuleType(WDHorizontalGutterRuleType value)

Sets the ruleType property to the given value.

Parameters:

value - the new value of the ruleType property

See Also:

getRuleType()

bindWidth

public void bindWidth(String path)

Binds the width property to the context attribute specified by the given path.

Parameters:

path - the context path of the attribute to which the width property will be bound

bindWidth

public void bindWidth(IWDAttributeInfo attributeInfo)

Binds the width property to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the width property will be bound

bindingOfWidth

public String bindingOfWidth()

Returns the binding path of the width property.

Returns:

the path of the context attribute to which the width property is currently bound

getWidth

public String getWidth()

Returns the value of the width property.

The initial value is "100%".

Specifies the width in CSS units such as em, ex, pixel, or percentage.

Returns:

the current value of the width property

See Also:

setWidth(String)

setWidth

public void setWidth(String value)

Sets the width property to the given value.

Parameters:

value - the new value of the width property

See Also:

getWidth()