com.businessobjects.rebean.wi
Interface Attributes


public interface Attributes

Warning: This interface is only available for TrackData and some methods are longer functional from the SAP BusinessObjects XI 4.0 release onwards.

The Attributes interface represents the (non font or alignment) attributes. *

See Also:
Decoration

Method Summary
 java.awt.Color getBackground()
          Returns the current background color.
 ImageDisplayMode getBackgroundImageDisplayMode()
          Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
 java.lang.String getBackgroundImageResource()
          Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
 java.lang.String getBackgroundImageURL()
          Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
 Border getBorder()
          Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
 java.awt.Color getForeground()
          Returns the current foreground color.
 Skin getSkin()
          Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
 void setBackground(java.awt.Color color)
          Changes the current background color.
 void setBackgroundImageDisplayMode(ImageDisplayMode dispMode)
          Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
 void setBackgroundImageResource(java.lang.String resourceId)
          Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
 void setBackgroundImageURL(java.lang.String url)
          Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
 void setForeground(java.awt.Color color)
          Changes the current foreground color.
 void setSkin(Skin skin)
          Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
 

Method Detail

getBackground

java.awt.Color getBackground()
Returns the current background color.

Returns:
the current background color, or null for the default color

setBackground

void setBackground(java.awt.Color color)
Changes the current background color.

Parameters:
color - the new background color, or null for the default color

getBackgroundImageURL

java.lang.String getBackgroundImageURL()

Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.

Returns the URL of the background image.

Returns:
the url, or null if there is no background image

setBackgroundImageURL

void setBackgroundImageURL(java.lang.String url)

Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.

Changes the background image. The new image replaces the old.

If url isn't valid, this call has no effect. If url is null, the old image will be erased. If Attributes.getBackgroundImageDisplayMode() and Decoration.setBackgroundAlignment(Alignment alignment) won't be called before, default ImageDisplayMode value and Alignment value should be applied to new URL image. About default values, see Attributes.getBackgroundImageDisplayMode() and Decoration.getBackgroundAlignment().

Parameters:
url - The new background image URL.

getSkin

Skin getSkin()

Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.

Returns the background skin. If the background image is a URL image, returns null.

Returns:
the Skin, or null if without skin.
Since:
11.5

setSkin

void setSkin(Skin skin)

Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.

Changes the background image by a skin image. The new image replaces the old. If skin is null, the old image will be erased.

Parameters:
skin - The skin returned by Attributes.getSkin().
Since:
11.5

getForeground

java.awt.Color getForeground()
Returns the current foreground color.

Returns:
the current foreground color, or null for the default color

setForeground

void setForeground(java.awt.Color color)
Changes the current foreground color.

Parameters:
color - the new foreground color, or null for the default color

getBorder

Border getBorder()

Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.

Returns the border.

Returns:
the border

setBackgroundImageDisplayMode

void setBackgroundImageDisplayMode(ImageDisplayMode dispMode)

Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.

Changes the background Url image display setting value ImageDisplayMode of current report element. This call on a skin will not have any effect.

Parameters:
dispMode - - ImageDisplayMode value.
Throws:
NullPointerException - when dispMode is null
Since:
11.5
See Also:
ImageDisplayMode

getBackgroundImageDisplayMode

ImageDisplayMode getBackgroundImageDisplayMode()

Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.

Gets the background display setting value ImageDisplayMode of current report element.

The default value is ImageDisplayMode.TILE for custom providing url image.

If the background is a skin from Attributes.getSkin(), ImageDisplayMode value is the same as Skin.getDisplayMode().

Returns:
ImageDisplayMode value.
Since:
11.5
See Also:
ImageDisplayMode

setBackgroundImageResource

void setBackgroundImageResource(java.lang.String resourceId)

Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.

Changes the background image by an embedded image previously uploaded using the ResourceManager. The new image resource replaces the old one or any skin or background image. If the skin is null, the old image will be erased.

Parameters:
resourceId - The resource Identifier given by the ResourceManager when calling ResourceManager.addResource(String, int, String, String, java.io.InputStream).
Since:
12.0

getBackgroundImageResource

java.lang.String getBackgroundImageResource()

Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.

Returns the current background image's resource identifier.

Returns:
The current background image resource identifier, or null if no background image resource was found.
Since:
12.0