com.goldencode.p2j.ui

Interface ImageSupport

All Known Subinterfaces:

ButtonInterface, ButtonList, ButtonListGroup, ButtonListGroupItem, Calendar, CommonListWidget<T>, CommonWidget, ControlFrame, Group, HandleCommon, ImageWidgetSupport

All Known Implementing Classes:

BaseEntity, BrowseColumnWidget, BrowseWidget, ButtonListGroupItemWidget, ButtonListGroupWidget, ButtonListWidget, ButtonWidget, CalendarWidget, ChartWidget, ComboBoxWidget, ControlEntity, ControlEntityExt, ControlFrameWidget, ControlSetEntity, ControlTextWidget, EditorWidget, FieldGroup, FillInWidget, FrameWidget, GenericWidget, HtmlBrowserWidget, ImageListWidget, ImageWidget, LiteralWidget, MenuContainerWidget, MenuItemWidget, MenuWidget, PaneEntity, ProgressBarWidget, RadioSetWidget, RectangleWidget, SelectionListWidget, SignatureWidget, SkipEntity, SliderWidget, SpreadsheetWidget, SubMenuWidget, TabSetWidget, TextBasedWidget, TextWidget, ToggleBoxWidget, TreeListWidget, TreeViewWidget, TreeWidgetBase, WindowWidget

public interface ImageSupport

Provide access to image loading widget-related APIs which can be accessed via handle instance.

Method Summary

Modifier and Type	Method and Description
logical	getConvert3D() Gets CONVERT-3D-COLORS attribute.
logical	loadImage(character name) Load widget(button or image) image from specified file name.
logical	loadImage(character name, int64 xOffset) Load widget(button or image) image from specified file name.
logical	loadImage(character name, int64 xOffset, int64 yOffset) Load widget(button or image) image from specified file name.
logical	loadImage(character name, int64 xOffset, int64 yOffset, int64 width) Load widget(button or image) image from specified file name.
logical	loadImage(character name, int64 xOffset, int64 yOffset, int64 width, int64 height) Load widget(button or image) image from specified file name.
boolean	loadImage(java.lang.String name) Load widget(button or image) image from specified file name.
boolean	loadImage(java.lang.String name, long xOffset) Load widget(button or image) image from specified file name.
boolean	loadImage(java.lang.String name, long xOffset, long yOffset) Load widget(button or image) image from specified file name.
boolean	loadImage(java.lang.String name, long xOffset, long yOffset, long width) Load widget(button or image) image from specified file name.
boolean	loadImage(java.lang.String name, long xOffset, long yOffset, long width, long height) Load widget(button or image) image from specified file name.
void	setConvert3D(boolean flag) Set CONVERT-3D-COLORS attribute.
void	setConvert3D(logical flag) Set CONVERT-3D-COLORS attribute.

Method Detail

loadImage

boolean loadImage(java.lang.String name)

Load widget(button or image) image from specified file name.

Parameters:

name - Image file name.

Returns:

true if operation was successful.

loadImage

boolean loadImage(java.lang.String name,
                  long xOffset)

Load widget(button or image) image from specified file name. This method overload allows to load only part of the image.

Parameters:

name - Image file name.

xOffset - An integer expression that specifies the pixel along the x-axis at which to begin reading from the image file.

Returns:

true if operation was successful.

loadImage

boolean loadImage(java.lang.String name,
                  long xOffset,
                  long yOffset)

Load widget(button or image) image from specified file name. This method overload allows to load only part of the image.

Parameters:

name - Image file name.

xOffset - An integer expression that specifies the pixel along the x-axis at which to begin reading from the image file.

yOffset - Specifies the pixel along the y-axis at which to begin reading from the image file.

Returns:

true if operation was successful.

loadImage

boolean loadImage(java.lang.String name,
                  long xOffset,
                  long yOffset,
                  long width)

Load widget(button or image) image from specified file name. This method overload allows to load only part of the image.

Parameters:

name - Image file name.

xOffset - An integer expression that specifies the pixel along the x-axis at which to begin reading from the image file.

yOffset - Specifies the pixel along the y-axis at which to begin reading from the image file.

width - Specifies the number of pixels along the x-axis to read from the image file.

Returns:

true if operation was successful.

loadImage

boolean loadImage(java.lang.String name,
                  long xOffset,
                  long yOffset,
                  long width,
                  long height)

Load widget(button or image) image from specified file name. This method overload allows to load only part of the image.

Parameters:

name - Image file name.

xOffset - An integer expression that specifies the pixel along the x-axis at which to begin reading from the image file.

yOffset - Specifies the pixel along the y-axis at which to begin reading from the image file.

width - Specifies the number of pixels along the x-axis to read from the image file.

height - Specifies the number of pixels along the y-axis to read from the image file.

Returns:

true if operation was successful.

loadImage

logical loadImage(character name)

Load widget(button or image) image from specified file name.

Parameters:

name - Image file name.

Returns:

true if operation was successful.

loadImage

logical loadImage(character name,
                  int64 xOffset)

Load widget(button or image) image from specified file name. This method overload allows to load only part of the image.

Parameters:

name - Image file name.

xOffset - An integer expression that specifies the pixel along the x-axis at which to begin reading from the image file.

Returns:

true if operation was successful.

loadImage

logical loadImage(character name,
                  int64 xOffset,
                  int64 yOffset)

Load widget(button or image) image from specified file name. This method overload allows to load only part of the image.

Parameters:

name - Image file name.

xOffset - An integer expression that specifies the pixel along the x-axis at which to begin reading from the image file.

yOffset - Specifies the pixel along the y-axis at which to begin reading from the image file.

Returns:

true if operation was successful.

loadImage

logical loadImage(character name,
                  int64 xOffset,
                  int64 yOffset,
                  int64 width)

Load widget(button or image) image from specified file name. This method overload allows to load only part of the image.

Parameters:

name - Image file name.

xOffset - An integer expression that specifies the pixel along the x-axis at which to begin reading from the image file.

yOffset - Specifies the pixel along the y-axis at which to begin reading from the image file.

width - Specifies the number of pixels along the x-axis to read from the image file.

Returns:

true if operation was successful.

loadImage

logical loadImage(character name,
                  int64 xOffset,
                  int64 yOffset,
                  int64 width,
                  int64 height)

Load widget(button or image) image from specified file name. This method overload allows to load only part of the image.

Parameters:

name - Image file name.

xOffset - An integer expression that specifies the pixel along the x-axis at which to begin reading from the image file.

yOffset - Specifies the pixel along the y-axis at which to begin reading from the image file.

width - Specifies the number of pixels along the x-axis to read from the image file.

height - Specifies the number of pixels along the y-axis to read from the image file.

Returns:

true if operation was successful.

getConvert3D

logical getConvert3D()

Gets CONVERT-3D-COLORS attribute.

Returns:

CONVERT-3D-COLORS current value.

setConvert3D

void setConvert3D(boolean flag)

Set CONVERT-3D-COLORS attribute.

Parameters:

flag - New value for the option.

setConvert3D

void setConvert3D(logical flag)

Set CONVERT-3D-COLORS attribute.

Parameters:

flag - New value for the option.