IconFit

Inheritance: java.lang.Object

public final class IconFit

Describes how the widget annotation’s icon shall be displayed within its annotation rectangle.

Methods

MethodDescription
getScalingReason()Gets scaling reason.
setScalingReason(int value)Sets scaling reason.
getScalingMode()The type of scaling that shall be used.
setScalingMode(int value)The type of scaling that shall be used.
getLeftoverLeft()Gets space to allocate at the left of the icon.
setLeftoverLeft(double value)Sets space to allocate at the left of the icon.
getLeftoverBottom()Gets space to allocate at the bottom of the icon.
setLeftoverBottom(double value)Sets space to allocate at the bottom of the icon.
isSpreadOnBorder()If true, indicates that the button appearance shall be scaled to fit fully within the bounds of the annotation without taking into consideration the line width of the border.
setSpreadOnBorder(boolean value)If true, indicates that the button appearance shall be scaled to fit fully within the bounds of the annotation without taking into consideration the line width of the border.
nameToScalingReason(String reason)Converts name of scaling reason into ScalingReason object.
scalingReasonToName(int reason)Converts scaling reason obejct to name.
nameToScalingMode(String mode)Converts scaling mode name into ScalingMode object.
scalingModeToName(int mode)Converts scaling mode object into name.

getScalingReason()

public int getScalingReason()

Gets scaling reason.

Returns: int - ScalingReason value

setScalingReason(int value)

public void setScalingReason(int value)

Sets scaling reason.

Parameters:

ParameterTypeDescription
valueintScalingReason value

getScalingMode()

public int getScalingMode()

The type of scaling that shall be used.

Returns: int - ScalingMode value

setScalingMode(int value)

public void setScalingMode(int value)

The type of scaling that shall be used.

Parameters:

ParameterTypeDescription
valueintScalingMode value

getLeftoverLeft()

public double getLeftoverLeft()

Gets space to allocate at the left of the icon.

Returns: double - space to allocate at the left of the icon.

setLeftoverLeft(double value)

public void setLeftoverLeft(double value)

Sets space to allocate at the left of the icon.

Parameters:

ParameterTypeDescription
valuedoublespace to allocate at the left of the icon.

getLeftoverBottom()

public double getLeftoverBottom()

Gets space to allocate at the bottom of the icon.

Returns: double - space to allocate at the bottom

setLeftoverBottom(double value)

public void setLeftoverBottom(double value)

Sets space to allocate at the bottom of the icon.

Parameters:

ParameterTypeDescription
valuedoublespace to allocate at the bottom

isSpreadOnBorder()

public boolean isSpreadOnBorder()

If true, indicates that the button appearance shall be scaled to fit fully within the bounds of the annotation without taking into consideration the line width of the border.

Returns: boolean - boolean value

setSpreadOnBorder(boolean value)

public void setSpreadOnBorder(boolean value)

If true, indicates that the button appearance shall be scaled to fit fully within the bounds of the annotation without taking into consideration the line width of the border.

Parameters:

ParameterTypeDescription
valuebooleanboolean value

nameToScalingReason(String reason)

public static int nameToScalingReason(String reason)

Converts name of scaling reason into ScalingReason object.

Parameters:

ParameterTypeDescription
reasonjava.lang.StringName of scaling reason.

Returns: int - Scaling reason object.

scalingReasonToName(int reason)

public static String scalingReasonToName(int reason)

Converts scaling reason obejct to name.

Parameters:

ParameterTypeDescription
reasonintScaling reason object to be converted.

Returns: java.lang.String - Name of scaling reasong.

nameToScalingMode(String mode)

public static int nameToScalingMode(String mode)

Converts scaling mode name into ScalingMode object.

Parameters:

ParameterTypeDescription
modejava.lang.StringScaling mode name.

Returns: int - Scaling mode object.

scalingModeToName(int mode)

public static String scalingModeToName(int mode)

Converts scaling mode object into name.

Parameters:

ParameterTypeDescription
modeintScaling mode object.

Returns: java.lang.String - Scaling mode name.