ilog.views

Class IlvBidiGraphic

java.lang.Object

ilog.views.IlvGraphic

ilog.views.IlvBidiGraphic

All Implemented Interfaces:

IlvPersistentObject, IlvBlinkingObject, IlvBaseTextDirectionInterface, Transferable, Serializable

Direct Known Subclasses:

IlvDoubleGraphicHandleBag, IlvGraphicSet, IlvLabel, IlvManager, IlvMapLabel, IlvScale, IlvText, IlvZoomableLabel

public abstract class IlvBidiGraphic
extends IlvGraphic

IlvBidiGraphic is an abstract base class for graphic objects that has a base text direction. Besides the storage for the base text direction, it provides cached access to locale and component orientation.

About Graphic Objects

IlvBidiGraphic is a base class for custom graphic objects, that is, a subclass of IlvGraphic. Graphic objects are controlled using an IlvManager instance and displayed using one or more IlvManagerView instances in a Java Swing application. For information about generic features for graphic objects, see IlvGraphic.

Since:

JViews 8.8

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvBidiGraphic() Creates a new IlvBidiGraphic.
IlvBidiGraphic(IlvBidiGraphic source) Creates a new IlvBidiGraphic by copying an existing one.
IlvBidiGraphic(IlvInputStream stream) Reads a graphic object from an IlvInputStream.

Method Summary

Modifier and Type	Method and Description
protected int	calcResolvedBaseTextDirection() Calculates the resolved base text direction when it is not cached.
int	getBaseTextDirection() Returns the base direction of the text.
ComponentOrientation	getComponentOrientation() Returns the component orientation of this object.
int	getResolvedBaseTextDirection() Returns the resolved base text direction.
com.ibm.icu.util.ULocale	getULocale() Returns the locale of this object.
protected void	invalidateBidiCache() Mark internal caches for locale, component orientation and base text direction invalid.
void	setBaseTextDirection(int baseTextDirection) Changes the base direction of the text.
void	setBaseTextDirection(int baseTextDirection, boolean redraw) Changes the base direction of the text.
protected void	setBaseTextDirectionDuringConstruction(int baseTextDirection) Changes the base direction of the text.

Methods inherited from class ilog.views.IlvGraphic

addActionListener, addNamedPropertyListener, allViewsRemoved, applyTransform, baseTextDirectionChanged, blinkingStateOn, boundingBox, boundingBox, callDraw, componentOrientationChanged, contains, copy, draw, getAndAssociateObjectInteractor, getBlinkingAction, getBlinkingObjectOwner, getBlinkingOffPeriod, getBlinkingOnPeriod, getCenter, getDefaultInteractor, getGraphicBag, GetGraphicObject, getIntersectionWithOutline, getLocale, getName, getNamedProperty, getObjectInteractor, getPopupMenu, getPopupMenu, getPopupMenuName, getProperty, getToolTipBaseTextDirection, getToolTipText, getToolTipText, getTopLevelGraphicBag, getTransferData, getTransferDataFlavors, getZOrderIndex, hasProperty, inside, intersects, invalidateBBoxCache, isBaseTextDirectionSensitive, isComponentOrientationSensitive, isDataFlavorSupported, isEditable, isInApplyToObject, isLocaleSensitive, isMovable, isPersistent, isSelectable, isVisible, localeChanged, makeSelection, move, move, moveResize, needsViewNotification, notifyObjectInteractorToManager, processActionEvent, reDraw, registerBlinkingResource, removeActionListener, removeNamedProperty, removeNamedPropertyListener, removeProperty, replaceProperty, resize, rotate, scale, setBackground, setBlinkingAction, setBlinkingOffPeriod, setBlinkingOnPeriod, setEditable, setFillOn, setForeground, setGraphicBag, setInApplyToObject, setMovable, setName, setNamedProperty, setNameImpl, setObjectInteractor, setPopupMenu, setPopupMenuName, setProperty, setSelectable, setStrokeOn, setToolTipBaseTextDirection, setToolTipText, setVisible, setZOrderIndex, toString, translate, updateNeedsViewNotification, usesBidiMarkers, viewAddedOrRemoved, write, zoomable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IlvBidiGraphic

public IlvBidiGraphic()

Creates a new IlvBidiGraphic.

IlvBidiGraphic

public IlvBidiGraphic(IlvBidiGraphic source)

Creates a new IlvBidiGraphic by copying an existing one.

Parameters:

source - The graphic object to be copied.

IlvBidiGraphic

public IlvBidiGraphic(IlvInputStream stream)
               throws IlvReadFileException

Reads a graphic object from an IlvInputStream.

Throws:

IlvReadFileException

Method Detail

getULocale

public com.ibm.icu.util.ULocale getULocale()

Returns the locale of this object. Use this method for the implementation of graphic objects that depend on the locale. Usually, such graphic objects must also override IlvGraphic.isLocaleSensitive() if the bounding box depends on the locale.

Note: Most predefined graphic objects are independent of locale.

If this object is contained in a graphic bag that has a locale, it returns the locale of that graphic bag. Otherwise it returns IlvLocaleUtil.getCurrentULocale(). Typically a graphic object is in a manager that is displayed in a manager view, and the returned value is the locale of the first manager view that displays the graphic.

Overrides:

getULocale in class IlvGraphic

Returns:

The locale of this object.

See Also:

IlvGraphic.localeChanged(com.ibm.icu.util.ULocale, com.ibm.icu.util.ULocale), IlvManager.getULocale(), IlvLocaleUtil.getCurrentULocale()

getComponentOrientation

public ComponentOrientation getComponentOrientation()

Returns the component orientation of this object. Use this method for the implementation of graphic objects that depend on the component orientation. Usually, such graphic objects must also override IlvGraphic.isComponentOrientationSensitive() if the bounding box depends on the component orientation.

Note: Most predefined graphic objects are independent of component orientation.

If this object is contained in a graphic bag that has a component orientation, it returns the component orientation of that graphic bag. Otherwise it returns ComponentOrientation.UNKNOWN.

Typically a graphic object is in a manager that is displayed in a manager view, and the returned value is the component orientation of the first manager view that displays the graphic.

Overrides:

getComponentOrientation in class IlvGraphic

Returns:

The component orientation of this object.

See Also:

IlvGraphic.componentOrientationChanged(java.awt.ComponentOrientation, java.awt.ComponentOrientation), IlvManager.getComponentOrientation()

setBaseTextDirection

public void setBaseTextDirection(int baseTextDirection)

Changes the base direction of the text. This is only relevant for subclasses that contain text. Should be overriden by subclasses, containing text, and by containers, which may involve objects, that contain text. The possible choices are:

• IlvBidiUtil.INHERITED_DIRECTION: the base text direction is inherited from the graphic bag that contains this object. If this object is not contained in a graphic bag, the base text direction is calculated from the component orientation.
• IlvBidiUtil.COMPONENT_DIRECTION: the base text direction is calculated from the component orientation.
• IlvBidiUtil.LEFT_TO_RIGHT: the base text direction is left-to-right.
• IlvBidiUtil.RIGHT_TO_LEFT: the base text direction is right-to-left.
• IlvBidiUtil.CONTEXTUAL_DIRECTION: the base test direction is determined from the text that is displayed according to the standard Bidi algorithm, if the text contains at least one character with a strong left-to-right or right-to-left direction. If the text doesn't contain any character with a strong direction, the real text direction is determined from the current component orientation of the object.

Specified by:

setBaseTextDirection in interface IlvBaseTextDirectionInterface

Overrides:

setBaseTextDirection in class IlvGraphic

Parameters:

baseTextDirection - The base text direction

See Also:

IlvGraphic.baseTextDirectionChanged(int, int)

setBaseTextDirection

public void setBaseTextDirection(int baseTextDirection,
                                 boolean redraw)

Changes the base direction of the text. See setBaseTextDirection(int).

Parameters:

baseTextDirection - The base text direction

redraw - Whether to redraw the object after the change.

setBaseTextDirectionDuringConstruction

protected void setBaseTextDirectionDuringConstruction(int baseTextDirection)

Changes the base direction of the text. Called by the constructors. You should not call this method.

Overrides:

setBaseTextDirectionDuringConstruction in class IlvGraphic

Parameters:

baseTextDirection - The base text direction

Since:

JViews 8.8

getBaseTextDirection

public int getBaseTextDirection()

Returns the base direction of the text. This is only relevant for subclasses that contain text. Should be overriden by subclasses, containing text, and by containers, which may involve objects, that contain text. The possible return values are:

• IlvBidiUtil.INHERITED_DIRECTION: the base text direction is inherited from the graphic bag that contains this object. If this object is not contained in a graphic bag, the base text direction is calculated from the component orientation.
• IlvBidiUtil.COMPONENT_DIRECTION: the base text direction is calculated from the component orientation.
• IlvBidiUtil.LEFT_TO_RIGHT: the base text direction is left-to-right.
• IlvBidiUtil.RIGHT_TO_LEFT: the base text direction is right-to-left.
• IlvBidiUtil.CONTEXTUAL_DIRECTION: the base test direction is determined from the text that is displayed according to the standard Bidi algorithm, if the text contains at least one character with a strong left-to-right or right-to-left direction. If the text doesn't contain any character with a strong direction, the real text direction is determined from the current component orientation of the object.

Specified by:

getBaseTextDirection in interface IlvBaseTextDirectionInterface

Overrides:

getBaseTextDirection in class IlvGraphic

Returns:

The base text direction.

getResolvedBaseTextDirection

public int getResolvedBaseTextDirection()

Returns the resolved base text direction.

This method is similar to getBaseTextDirection() but determines the value when it is inherited from a parent component (IlvBidiUtil.INHERITED_DIRECTION) or dependent on the component orientation (IlvBidiUtil.COMPONENT_DIRECTION). Hence, there are only 3 possible return values:

• IlvBidiUtil.LEFT_TO_RIGHT: the base text direction is left-to-right.
• IlvBidiUtil.RIGHT_TO_LEFT: the base text direction is right-to-left.
• IlvBidiUtil.CONTEXTUAL_DIRECTION: the base test direction is determined from the text that is displayed according to the standard Bidi algorithm, if the text contains at least one character with a strong left-to-right or right-to-left direction. If the text doesn't contain any character with a strong direction, the real text direction is determined from the current component orientation of the object.

Specified by:

getResolvedBaseTextDirection in interface IlvBaseTextDirectionInterface

Overrides:

getResolvedBaseTextDirection in class IlvGraphic

Returns:

The resolved base text direction.

calcResolvedBaseTextDirection

protected int calcResolvedBaseTextDirection()

Calculates the resolved base text direction when it is not cached.

Returns:

The resolved base text direction.

invalidateBidiCache

protected void invalidateBidiCache()

Mark internal caches for locale, component orientation and base text direction invalid.

Overrides:

invalidateBidiCache in class IlvGraphic