IlvDefaultManagerFrame (Rogue Wave JViews 9.1 API)

java.lang.Object
- ilog.views.IlvDefaultManagerFrame

All Implemented Interfaces:

IlvManagerFrame, IlvResizableManagerFrame, IlvPersistentObject, IlvBaseTextDirectionInterface, Serializable

Direct Known Subclasses:

IlvConstantModeManagerFrame
```
public class IlvDefaultManagerFrame
extends Object
implements IlvResizableManagerFrame, Serializable, IlvBaseTextDirectionInterface, IlvPersistentObject
```
The default frame for an IlvManager. The IlvDefaultManagerFrame class defines the default frame that is drawn around an IlvManager when this manager is added into another manager. This class defines the margin that will be added around the manager. A title can be drawn on the top and you can specify the alignment of the title. By default the title is the name of the manager.
You can change the horizontal alignment of the title. The default is left aligned. Since JViews 8.0, you can specify the vertical alignment of the title. The default is top aligned, if you have not specified the vertical alignment. This allows you to keep the compatibility with previous versions.

Since:

JViews 5.0

See Also:

IlvManager.setFrame(ilog.views.IlvManagerFrame), Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BOTTOM` Defines the BOTTOM alignment for the title.
`static int`	`CENTER` Defines the CENTER alignment for the title.
`static int`	`LEFT` Defines the LEFT alignment for the title.
`static int`	`RIGHT` Defines the RIGHT alignment for the title.
`static int`	`TOP` Defines the TOP alignment for the title.
`static int`	`WRAPPED` Indicates that the title can be wrapped.

Constructor Summary

Constructors
Constructor and Description
`IlvDefaultManagerFrame()` Creates a default manager frame.
`IlvDefaultManagerFrame(IlvDefaultManagerFrame source)` Creates an `IlvDefaultManagerFrame` by copying the specified one.
`IlvDefaultManagerFrame(IlvInputStream stream)` Reads an `IlvDefaultManagerFrame` from an `IlvInputStream`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`baseTextDirectionChanged(IlvManager manager, int oldBaseTextDirection, int newBaseTextDirection)` Called when the object is base text direction sensitive and the resolved base text direction has changed.
`IlvRect`	`boundingBoxExpandCollapseIcon(IlvManager manager, IlvRect bbox, IlvTransformer t)` Returns the bounding box of the expand/collapse icon for a given manager.
`protected double`	`checkZoomFactor(IlvTransformer t)` This utility function checks the zoom factor of the given transformer.
`void`	`componentOrientationChanged(IlvManager manager, ComponentOrientation oldOri, ComponentOrientation newOri)` Called when the object is component orientation sensitive and the component orientation has changed.
`boolean`	`contains(IlvManager manager, IlvPoint p, IlvPoint tp, IlvTransformer t)` Tests if a point lies within the outline of the frame.
`IlvManagerFrame`	`copy()` Creates an `IlvDefaultManagerFrame` by copying this one.
`void`	`draw(IlvManager manager, IlvRect bbox, Graphics g, IlvTransformer t)` Draws the frame.
`protected void`	`drawBackground(IlvManager manager, IlvRect bbox, Graphics grp, IlvTransformer transf)` This method fills the given bounding box with the background color.
`void`	`drawExpandCollapseIcon(IlvManager manager, IlvRect bbox, Graphics g, IlvTransformer t)` Draws the expand/collapse icon for a given manager.
`protected void`	`drawOutline(IlvManager manager, IlvRect bbox, Graphics grp, IlvTransformer transf)` This method draws the border of the manager frame outline.
`protected void`	`drawShadow(IlvManager manager, IlvRect bbox, Graphics grp, IlvTransformer transf)` This method draws the shadow of the manager frame.
`protected void`	`drawTitleBackground(IlvManager manager, IlvRect bbox, Graphics grp, IlvTransformer transf)` This method fills the given bounding box with the background color.
`protected void`	`drawTitleText(IlvManager manager, IlvRect bbox, Graphics grp, IlvTransformer transf)` This method draws the title text within the title area.
`IlvPoint`	`getAbsoluteExpandCollapseIconPosition()` Returns the absolute position of the icon that represents the expand or collapse state of the frame.
`Paint`	`getBackground()` Returns the `Paint` object used to draw the background of the manager when the frame is opaque.
`int`	`getBaseTextDirection()` Returns the base direction of the title text.
`double`	`getBottomMargin()` Returns the bottom margin.
`double`	`getBottomMargin(IlvManager manager, IlvTransformer t)` Returns the margin on the bottom of the specified manager.
`IlvGraphic`	`getExpandCollapseIcon()` Returns the icon that represents the expand or collapse state of the frame.
`protected IlvPoint`	`getExpandCollapseIconPosition(IlvManager manager, IlvRect bbox, IlvTransformer t)` Calculates the position of the expand/collapse icon at the manager.
`Font`	`getFont()` Returns the font used to draw the text of the title.
`Color`	`getForeground()` Returns the color used to draw the frame.
`double`	`getLeftMargin()` Returns the left margin.
`double`	`getLeftMargin(IlvManager manager, IlvTransformer t)` Returns the margin on the left of the specified manager.
`double`	`getMaxTitleZoomFactor()` Returns the maximum zoom factor for the title.
`double`	`getMinTitleZoomFactor()` Returns the minimum zoom factor for the title.
`boolean`	`getOpaque()` Returns `true` if the frame is opaque meaning that the frame is filling the background of the manager.
`IlvPoint`	`getRelativeExpandCollapseIconPosition()` Returns the relative position of the icon that represents the expand or collapse state of the frame.
`int`	`getResolvedBaseTextDirection()` Returns the resolved base text direction of the title text.
`int`	`getResolvedBaseTextDirection(IlvManager manager)` Returns the resolved base text direction of the title text for a given manager.
`double`	`getRightMargin()` Returns the right margin.
`double`	`getRightMargin(IlvManager manager, IlvTransformer t)` Returns the margin on the right of the specified manager.
`Paint`	`getShadowPaint()` Returns the paint of the shadow used to draw the frame.
`int`	`getShadowPosition()` Returns the position of the shadow used to draw the frame.
`double`	`getShadowThickness()` Returns the thickness of the shadow used to draw the frame.
`String`	`getTitle()` Returns the title of the frame.
`protected String`	`getTitle(IlvManager m)` Returns the title of the frame.
`Color`	`getTitleColor()` Returns the color used to draw the text of the title.
`double`	`getTitleHeight(IlvManager manager, IlvTransformer t)` Returns the height of the frame title.
`int`	`getTitleJustification()` Returns the justification of the frame title.
`double`	`getTopMargin()` Returns the top margin.
`double`	`getTopMargin(IlvManager manager, IlvTransformer t)` Returns the total top margin for a specified manager.
`boolean`	`isOpaque(IlvManager manager)` Returns `true` if the frame is opaque meaning that the frame is filling the background of the manager.
`boolean`	`isShowingExpandCollapseIcon()` Returns whether the icon that represents the expand or collapse state of the frame is shown.
`boolean`	`isShowingTitle()` Returns whether the title is visible or not.
`void`	`localeChanged(IlvManager manager, ULocale oldLocale, ULocale newLocale)` Called when the object is locale sensitive and the locale has changed.
`void`	`managerChanged(IlvManager manager)` This function adjusts the frame in reaction to the inner manager's change.
`boolean`	`moveResize(IlvManager manager, IlvRect size)` This function invalidates the frame and does not handle the inner manager's resizing.
`void`	`setAbsoluteExpandCollapseIconPosition(IlvPoint p)` Sets the absolute position of the icon that represents the expand or collapse state of the frame.
`void`	`setBackground(Paint p)` Changes the `Paint` object used to draw the background of the manager when the frame is opaque.
`void`	`setBaseTextDirection(IlvManager manager, int baseTextDirection)` Changes the base direction of the title text.
`void`	`setBaseTextDirection(int baseTextDirection)` Changes the base direction of the title text.
`void`	`setBottomMargin(double margin)` Sets the bottom margin.
`void`	`setExpandCollapseIcon(IlvGraphic g)` Sets the icon that represents the expand or collapse state of the frame.
`void`	`setExpandCollapseIconPosition(double relX, double relY, double absX, double absY)` Sets the position of the icon that represents the expand or collapse state of the frame.
`void`	`setFont(Font font)` Changes the font used to draw the text of the title.
`void`	`setForeground(Color color)` Changes the color used to draw the frame.
`void`	`setLeftMargin(double margin)` Sets the left margin.
`void`	`setMaxTitleZoomFactor(double maxTitleZoomFactor)` Sets the maximum title zoom factor for the title.
`void`	`setMinTitleZoomFactor(double minTitleZoomFactor)` Sets the minimum zoom factor for the title.
`void`	`setOpaque(boolean value)` Changes the opacity of the frame.
`void`	`setRelativeExpandCollapseIconPosition(IlvPoint p)` Sets the relative position of the icon that represents the expand or collapse state of the frame.
`void`	`setRightMargin(double margin)` Sets the right margin.
`void`	`setShadowPaint(Paint paint)` Changes the paint of the shadow used to draw the frame.
`void`	`setShadowPosition(int shadowPosition)` Changes the position of the shadow used to draw the frame.
`void`	`setShadowThickness(double thickness)` Changes the thickness of the shadow used to draw the frame.
`void`	`setShowingExpandCollapseIcon(boolean show)` Sets whether the icon that represents the expand or collapse state of the frame is shown.
`void`	`setShowingTitle(boolean set)` Shows or hides the title.
`void`	`setTitle(String title)` Sets the title of the frame.
`void`	`setTitleColor(Color color)` Changes the color used to draw the text of the title.
`void`	`setTitleJustification(int value)` Changes the justification of the frame title.
`void`	`setTopMargin(double margin)` Sets the top margin.
`void`	`write(IlvOutputStream stream)` Writes the frame to an `IlvOutputStream`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LEFT
```
public static final int LEFT
```
    Defines the LEFT alignment for the title.
    
    See Also:
    
    Constant Field Values
  - CENTER
```
public static final int CENTER
```
    Defines the CENTER alignment for the title.
    
    See Also:
    
    Constant Field Values
  - RIGHT
```
public static final int RIGHT
```
    Defines the RIGHT alignment for the title.
    
    See Also:
    
    Constant Field Values
  - TOP
```
public static final int TOP
```
    Defines the TOP alignment for the title.
    
    Since:
    
    JViews 8.0
    
    See Also:
    
    Constant Field Values
  - BOTTOM
```
public static final int BOTTOM
```
    Defines the BOTTOM alignment for the title.
    
    Since:
    
    JViews 8.0
    
    See Also:
    
    Constant Field Values
  - WRAPPED
```
public static final int WRAPPED
```
    Indicates that the title can be wrapped.
    
    Since:
    
    JViews 8.0
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - IlvDefaultManagerFrame
```
public IlvDefaultManagerFrame()
```
    Creates a default manager frame.
  - IlvDefaultManagerFrame
```
public IlvDefaultManagerFrame(IlvDefaultManagerFrame source)
```
    Creates an IlvDefaultManagerFrame by copying the specified one.
    
    Parameters:
    
    source - the origin of the copy.
    
    See Also:
    
    copy()
  - IlvDefaultManagerFrame
```
public IlvDefaultManagerFrame(IlvInputStream stream)
                       throws IOException,
                              IlvReadFileException
```
    Reads an IlvDefaultManagerFrame from an IlvInputStream.
    
    Parameters:
    
    stream - The input stream.
    
    Throws:
    
    IOException
    
    IlvReadFileException
- Method Detail
  - copy
```
public IlvManagerFrame copy()
```
    Creates an IlvDefaultManagerFrame by copying this one.
    
    Specified by:
    
    copy in interface IlvManagerFrame
  - write
```
public void write(IlvOutputStream stream)
           throws IOException
```
    Writes the frame to an IlvOutputStream.
    
    Specified by:
    
    write in interface IlvPersistentObject
    
    Parameters:
    
    stream - The output stream.
    
    Throws:
    
    IOException - thrown when an exception occurs during the write operation for this object.
  - setExpandCollapseIcon
```
public void setExpandCollapseIcon(IlvGraphic g)
```
    Sets the icon that represents the expand or collapse state of the frame.
    
    Since:
    
    JViews 8.8
  - getExpandCollapseIcon
```
public IlvGraphic getExpandCollapseIcon()
```
    Returns the icon that represents the expand or collapse state of the frame.
    
    Since:
    
    JViews 8.8
  - isShowingExpandCollapseIcon
```
public boolean isShowingExpandCollapseIcon()
```
    Returns whether the icon that represents the expand or collapse state of the frame is shown.
    
    Since:
    
    JViews 8.8
  - setShowingExpandCollapseIcon
```
public void setShowingExpandCollapseIcon(boolean show)
```
    Sets whether the icon that represents the expand or collapse state of the frame is shown. It calls setExpandCollapseIcon(ilog.views.IlvGraphic) to install or deinstall the icon.
    
    Since:
    
    JViews 8.8
  - setExpandCollapseIconPosition
```
public void setExpandCollapseIconPosition(double relX,
                                          double relY,
                                          double absX,
                                          double absY)
```
    Sets the position of the icon that represents the expand or collapse state of the frame. The position is the sum of the absolute position and the relative position. It denotes the center point of the icon. The relative position (0,0) is the top left corner, and (1,1) the bottom right corner of the frame. The absolute positions are added as manager coordinates.
    
    Parameters:
    
    relX - The relative x position.
    
    relY - The relative y position.
    
    absX - The absolute x position.
    
    absY - The absolute y position.
    
    Since:
    
    JViews 8.8
  - getRelativeExpandCollapseIconPosition
```
public final IlvPoint getRelativeExpandCollapseIconPosition()
```
    Returns the relative position of the icon that represents the expand or collapse state of the frame. The relative position (0,0) is the top left corner, and (1,1) the bottom * right corner of the frame.
    
    Since:
    
    JViews 8.8
    
    See Also:
    
    setExpandCollapseIconPosition(double, double, double, double)
  - setRelativeExpandCollapseIconPosition
```
public void setRelativeExpandCollapseIconPosition(IlvPoint p)
```
    Sets the relative position of the icon that represents the expand or collapse state of the frame. The relative position (0,0) is the top left corner, and (1,1) the bottom * right corner of the frame.
    
    Since:
    
    JViews 8.8
    
    See Also:
    
    setExpandCollapseIconPosition(double, double, double, double)
  - getAbsoluteExpandCollapseIconPosition
```
public final IlvPoint getAbsoluteExpandCollapseIconPosition()
```
    Returns the absolute position of the icon that represents the expand or collapse state of the frame. This is added to the relative position.
    
    Since:
    
    JViews 8.8
    
    See Also:
    
    setExpandCollapseIconPosition(double, double, double, double)
  - setAbsoluteExpandCollapseIconPosition
```
public void setAbsoluteExpandCollapseIconPosition(IlvPoint p)
```
    Sets the absolute position of the icon that represents the expand or collapse state of the frame. This is added to the relative position.
    
    Since:
    
    JViews 8.8
    
    See Also:
    
    setExpandCollapseIconPosition(double, double, double, double)
  - getTopMargin
```
public double getTopMargin(IlvManager manager,
                           IlvTransformer t)
```
    Returns the total top margin for a specified manager.
    The total top margin is the sum of the height of the title plus the top margin, if the title is top aligned.
    
    Specified by:
    
    getTopMargin in interface IlvManagerFrame
    
    Parameters:
    
    manager - The inner manager.
    
    t - The transformer used to draw the manager and the frame.
    
    Returns:
    
    The total top margin for a specified manager.
    
    See Also:
    
    getTitleHeight(IlvManager, IlvTransformer), getTopMargin()
  - moveResize
```
public boolean moveResize(IlvManager manager,
                          IlvRect size)
```
    This function invalidates the frame and does not handle the inner manager's resizing. The parameters are ignored.
    
    Specified by:
    
    moveResize in interface IlvResizableManagerFrame
    
    Parameters:
    
    manager - The submanager to be transformed.
    
    size - The new size of the submanager.
    
    Returns:
    
    Always false.
    
    Since:
    
    JViews 8.0
  - managerChanged
```
public void managerChanged(IlvManager manager)
```
    This function adjusts the frame in reaction to the inner manager's change. It is typically called by the afterTransform() method of the inner manager.
    
    Specified by:
    
    managerChanged in interface IlvResizableManagerFrame
    
    Parameters:
    
    manager - The inner manager that has been changed.
    
    Since:
    
    JViews 8.0
  - checkZoomFactor
```
protected double checkZoomFactor(IlvTransformer t)
```
    This utility function checks the zoom factor of the given transformer.
    
    Parameters:
    
    t - The transformer to be checked.
    
    Returns:
    
    One of the 3 possibilities: 1) The zoom factor of the given transformer, if it is in the specified range. 2) The maximum zoom factor for the title. 3) The minimum zoom factor for the title.
    
    Since:
    
    JViews 8.1
    
    See Also:
    
    setMaxTitleZoomFactor(double), getMaxTitleZoomFactor(), setMinTitleZoomFactor(double), getMinTitleZoomFactor()
    
    Internal: do not use!
  - getTitleHeight
```
public double getTitleHeight(IlvManager manager,
                             IlvTransformer t)
```
    Returns the height of the frame title.
    
    Parameters:
    
    manager - The inner manager.
    
    t - The transformer used to draw both the manager and the frame.
    
    Returns:
    
    The frame title height. Returns 0 if the frame has no title or if isShowingTitle() returns false.
    
    Since:
    
    JViews 7.5
    
    See Also:
    
    isShowingTitle(), getTitle(IlvManager), getMinTitleZoomFactor(), getMaxTitleZoomFactor()
  - getTopMargin
```
public double getTopMargin()
```
    Returns the top margin. This method does not take into account the title.
  - setTopMargin
```
public void setTopMargin(double margin)
```
    Sets the top margin. This method does not take into account the title.
  - getBottomMargin
```
public double getBottomMargin(IlvManager manager,
                              IlvTransformer t)
```
    Returns the margin on the bottom of the specified manager. It contains the title height if it is bottom aligned.
    
    Specified by:
    
    getBottomMargin in interface IlvManagerFrame
    
    Parameters:
    
    manager - The inner manager.
    
    t - The transformer used to draw the manager and the frame.
  - getBottomMargin
```
public double getBottomMargin()
```
    Returns the bottom margin.
  - setBottomMargin
```
public void setBottomMargin(double margin)
```
    Sets the bottom margin.
  - getRightMargin
```
public double getRightMargin(IlvManager manager,
                             IlvTransformer t)
```
    Returns the margin on the right of the specified manager.
    
    Specified by:
    
    getRightMargin in interface IlvManagerFrame
    
    Parameters:
    
    manager - The inner manager.
    
    t - The transformer used to draw the manager and the frame.
  - getRightMargin
```
public double getRightMargin()
```
    Returns the right margin.
  - setRightMargin
```
public void setRightMargin(double margin)
```
    Sets the right margin.
  - getLeftMargin
```
public double getLeftMargin(IlvManager manager,
                            IlvTransformer t)
```
    Returns the margin on the left of the specified manager.
    
    Specified by:
    
    getLeftMargin in interface IlvManagerFrame
    
    Parameters:
    
    manager - The inner manager.
    
    t - The transformer used to draw the manager and the frame.
  - getLeftMargin
```
public double getLeftMargin()
```
    Returns the left margin.
  - setLeftMargin
```
public void setLeftMargin(double margin)
```
    Sets the left margin.
  - isOpaque
```
public boolean isOpaque(IlvManager manager)
```
    Returns true if the frame is opaque meaning that the frame is filling the background of the manager.
    
    Specified by:
    
    isOpaque in interface IlvManagerFrame
    
    Parameters:
    
    manager - The inner manager.
    
    See Also:
    
    setOpaque(boolean), getOpaque()
  - getOpaque
```
public boolean getOpaque()
```
    Returns true if the frame is opaque meaning that the frame is filling the background of the manager.
    
    Parameters:
    
    manager - The inner manager.
    
    See Also:
    
    setOpaque(boolean)
  - setOpaque
```
public void setOpaque(boolean value)
```
    Changes the opacity of the frame. When the frame is opaque the frame is filling the background of the manager.
    
    Parameters:
    
    value - The new opacity.
    
    See Also:
    
    isOpaque(IlvManager), getBackground()
  - getTitleColor
```
public Color getTitleColor()
```
    Returns the color used to draw the text of the title.
    
    See Also:
    
    setTitleColor(java.awt.Color)
  - setTitleColor
```
public void setTitleColor(Color color)
```
    Changes the color used to draw the text of the title.
    
    Parameters:
    
    color - The new color.
    
    See Also:
    
    getTitleColor()
  - getFont
```
public Font getFont()
```
    Returns the font used to draw the text of the title.
    
    See Also:
    
    setTitleColor(java.awt.Color)
  - setFont
```
public void setFont(Font font)
```
    Changes the font used to draw the text of the title.
    
    Parameters:
    
    font - The new font.
    
    See Also:
    
    getFont()
  - getBackground
```
public Paint getBackground()
```
    Returns the Paint object used to draw the background of the manager when the frame is opaque.
    
    See Also:
    
    setBackground(java.awt.Paint), setOpaque(boolean)
  - setBackground
```
public void setBackground(Paint p)
```
    Changes the Paint object used to draw the background of the manager when the frame is opaque.
    
    See Also:
    
    getBackground(), setOpaque(boolean)
  - getForeground
```
public Color getForeground()
```
    Returns the color used to draw the frame.
    
    See Also:
    
    setForeground(java.awt.Color)
  - setForeground
```
public void setForeground(Color color)
```
    Changes the color used to draw the frame.
    
    Parameters:
    
    color - The new color.
    
    See Also:
    
    getForeground()
  - isShowingTitle
```
public boolean isShowingTitle()
```
    Returns whether the title is visible or not.
    
    See Also:
    
    setShowingTitle(boolean), getTitle(), getTitleColor(), getFont(), getTitleJustification()
  - setShowingTitle
```
public void setShowingTitle(boolean set)
```
    Shows or hides the title.
    
    Parameters:
    
    set - The new value.
    
    See Also:
    
    isShowingTitle(), getTitle(), getTitleColor(), getFont(), getTitleJustification()
  - setTitleJustification
```
public void setTitleJustification(int value)
```
    Changes the justification of the frame title. If the vertical alignment is not specified, the default is TOP aligned.
    Parameters:
    value - The new justification can be a combination from the next 3 groups:
    
    Only one of the LEFT, CENTER, RIGHT for horizontal alignment;
    
    Only one of the TOP, BOTTOM for vertical alignment. If not specified, the default is TOP;
    
    WRAPPED, the default is not wrapped.
    
    Examples: LEFT, LEFT|BOTTOM, CENTER|BOTTOM|WRAPPED
    See Also:
    
    setTitleJustification(int), isShowingTitle()
  - getTitleJustification
```
public int getTitleJustification()
```
    Returns the justification of the frame title. See setTitleJustification(int) for possible values.
    
    See Also:
    
    setTitleJustification(int), isShowingTitle()
  - setBaseTextDirection
```
public void setBaseTextDirection(int baseTextDirection)
```
    Changes the base direction of the title 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
    
    Parameters:
    
    baseTextDirection - The base text direction
    
    Since:
    
    JViews 8.8
  - setBaseTextDirection
```
public void setBaseTextDirection(IlvManager manager,
                                 int baseTextDirection)
```
    Changes the base direction of the title text. See setBaseTextDirection(int) for details.
    
    Parameters:
    
    manager - The affected manager. Can be null.
    
    baseTextDirection - The base text direction
    
    Since:
    
    JViews 8.8
  - getBaseTextDirection
```
public int getBaseTextDirection()
```
    Returns the base direction of the title 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
    
    Returns:
    
    The base text direction.
    
    Since:
    
    JViews 8.8
  - getResolvedBaseTextDirection
```
public int getResolvedBaseTextDirection()
```
    Returns the resolved base text direction of the title text.
    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
    
    Returns:
    
    The resolved base text direction.
    
    Since:
    
    JViews 8.8
  - getResolvedBaseTextDirection
```
public int getResolvedBaseTextDirection(IlvManager manager)
```
    Returns the resolved base text direction of the title text for a given manager. See getResolvedBaseTextDirection() for details.
    
    Parameters:
    
    manager - The manager
    
    Returns:
    
    The resolved base text direction.
    
    Since:
    
    JViews 8.8
  - baseTextDirectionChanged
```
public void baseTextDirectionChanged(IlvManager manager,
                                     int oldBaseTextDirection,
                                     int newBaseTextDirection)
```
    Called when the object is base text direction sensitive and the resolved base text direction has changed.
    
    Parameters:
    
    manager - The affected manager. Can be null.
    
    oldBaseTextDirection - Resolved base text direction of this object before the change.
    
    newBaseTextDirection - Resolved base text direction of this object after the change.
    
    Since:
    
    JViews 8.8
  - componentOrientationChanged
```
public void componentOrientationChanged(IlvManager manager,
                                        ComponentOrientation oldOri,
                                        ComponentOrientation newOri)
```
    Called when the object is component orientation sensitive and the component orientation has changed.
    
    Parameters:
    
    manager - The affected manager. Can be null.
    
    oldOri - Orientation of this object before the orientation change.
    
    newOri - Orientation of this object after the orientation change.
    
    Since:
    
    JViews 8.8
  - localeChanged
```
public void localeChanged(IlvManager manager,
                          ULocale oldLocale,
                          ULocale newLocale)
```
    Called when the object is locale sensitive and the locale has changed.
    
    Parameters:
    
    manager - The affected manager. Can be null.
    
    oldLocale - Locale of this object before the locale change.
    
    newLocale - Locale of this object after the locale change.
    
    Since:
    
    JViews 8.8
  - draw
```
public void draw(IlvManager manager,
                 IlvRect bbox,
                 Graphics g,
                 IlvTransformer t)
```
    Draws the frame.
    
    Specified by:
    
    draw in interface IlvManagerFrame
    
    Parameters:
    
    manager - The inner manager.
    
    bbox - The bounding box of the manager in view coordinates.
    
    g - The Graphics used to draw the frame.
    
    t - The transformer used to draw the frame.
  - drawTitleText
```
protected void drawTitleText(IlvManager manager,
                             IlvRect bbox,
                             Graphics grp,
                             IlvTransformer transf)
```
    This method draws the title text within the title area. It is called internally by the main draw method (draw(IlvManager, IlvRect, Graphics, IlvTransformer)).
    If needed, sublcasses can override this method.
    
    Parameters:
    
    manager - The inner manager.
    
    bbox - The bounding box of the title area in view coordinates.
    
    grp - The Graphics used to draw the text.
    
    transf - The transformer used to draw the title.
    
    Since:
    
    JViews 8.1
    
    Internal: do not use!
  - drawTitleBackground
```
protected void drawTitleBackground(IlvManager manager,
                                   IlvRect bbox,
                                   Graphics grp,
                                   IlvTransformer transf)
```
    This method fills the given bounding box with the background color. It is called internally by the main draw method (draw(IlvManager, IlvRect, Graphics, IlvTransformer)) to handle the drawing of the background of the text area.
    If needed, subclasses can override this method.
    
    Parameters:
    
    manager - The inner manager.
    
    bbox - The bounding box of the title area in view coordinates.
    
    grp - The Graphics used to draw the text.
    
    transf - The transformer used to draw the title.
    
    Since:
    
    JViews 8.1
    
    Internal: do not use!
  - drawBackground
```
protected void drawBackground(IlvManager manager,
                              IlvRect bbox,
                              Graphics grp,
                              IlvTransformer transf)
```
    This method fills the given bounding box with the background color. It is called internally by the main draw method (draw(IlvManager, IlvRect, Graphics, IlvTransformer)) to handle the drawing of the background of the frame (excluding the title area).
    If needed, subclasses can override this method.
    
    Parameters:
    
    manager - The inner manager.
    
    bbox - The bounding box of the background area in view coordinates.
    
    grp - The Graphics used to draw the background.
    
    transf - The transformer used to draw the background.
    
    Since:
    
    JViews 8.1
    
    Internal: do not use!
  - drawOutline
```
protected void drawOutline(IlvManager manager,
                           IlvRect bbox,
                           Graphics grp,
                           IlvTransformer transf)
```
    This method draws the border of the manager frame outline. It is called internally by the main draw method (draw(IlvManager, IlvRect, Graphics, IlvTransformer)) to handle the drawing of the outline of the frame (including the text area).
    If needed, subclasses can override this method.
    
    Parameters:
    
    manager - The inner manager.
    
    bbox - The bounding box of the outline in view coordinates.
    
    grp - The Graphics used to draw the outline.
    
    transf - The transformer used to draw the outline.
    
    Since:
    
    JViews 8.1
    
    Internal: do not use!
  - drawShadow
```
protected void drawShadow(IlvManager manager,
                          IlvRect bbox,
                          Graphics grp,
                          IlvTransformer transf)
```
    This method draws the shadow of the manager frame. It is called internally by the main draw method (draw(IlvManager, IlvRect, Graphics, IlvTransformer)) to handle the drawing of the shadow of the frame.
    If needed, subclasses can override this method.
    
    Parameters:
    
    manager - The inner manager.
    
    bbox - The bounding box of manager frame.
    
    grp - The Graphics used to draw frame.
    
    transf - The transformer used to draw the frame.
    
    Since:
    
    JViews 8.5
    
    Internal: do not use!
  - drawExpandCollapseIcon
```
public void drawExpandCollapseIcon(IlvManager manager,
                                   IlvRect bbox,
                                   Graphics g,
                                   IlvTransformer t)
```
    Draws the expand/collapse icon for a given manager.
    
    Parameters:
    
    manager - The inner manager.
    
    bbox - The bounding box of the manager in view coordinates.
    
    g - The Graphics used to draw the frame.
    
    t - The transformer used to draw the frame.
    
    Since:
    
    JViews 8.8
  - boundingBoxExpandCollapseIcon
```
public IlvRect boundingBoxExpandCollapseIcon(IlvManager manager,
                                             IlvRect bbox,
                                             IlvTransformer t)
```
    Returns the bounding box of the expand/collapse icon for a given manager. Returns null if there is not expand/collapse icon.
    
    Parameters:
    
    manager - The inner manager.
    
    bbox - The bounding box of the manager in view coordinates.
    
    t - The transformer used to draw the frame.
    
    Since:
    
    JViews 8.8
  - getExpandCollapseIconPosition
```
protected IlvPoint getExpandCollapseIconPosition(IlvManager manager,
                                                 IlvRect bbox,
                                                 IlvTransformer t)
```
    Calculates the position of the expand/collapse icon at the manager.
    
    Parameters:
    
    manager - The inner manager.
    
    bbox - The bounding box of the manager in view coordinates.
    
    t - The transformer used to draw the frame.
    
    Since:
    
    JViews 8.8
  - contains
```
public boolean contains(IlvManager manager,
                        IlvPoint p,
                        IlvPoint tp,
                        IlvTransformer t)
```
    Tests if a point lies within the outline of the frame.
    
    Specified by:
    
    contains in interface IlvManagerFrame
    
    Parameters:
    
    manager - The inner manager.
    
    p - The point to be tested.
    
    tp - The point p transformed by the transformer t.
    
    t - The transformation that is used to draw the frame.
  - getTitle
```
protected String getTitle(IlvManager m)
```
    Returns the title of the frame. If setTitle(java.lang.String) was called with a non-null title string, this string is returned. Otherwise, this method returns the name of the manager (IlvGraphic.getName()). If the manager has no name, it returns the string 'Untitled'.
  - setTitle
```
public void setTitle(String title)
```
    Sets the title of the frame.
    
    Parameters:
    
    title - The new title of the frame.
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    getTitle(ilog.views.IlvManager)
  - getTitle
```
public String getTitle()
```
    Returns the title of the frame.
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    setTitle(java.lang.String), getTitle(ilog.views.IlvManager)
  - getMinTitleZoomFactor
```
public double getMinTitleZoomFactor()
```
    Returns the minimum zoom factor for the title.
    
    Returns:
    
    The minimum zoom factor for the title.
    
    Since:
    
    JViews 6.0
  - setMinTitleZoomFactor
```
public void setMinTitleZoomFactor(double minTitleZoomFactor)
```
    Sets the minimum zoom factor for the title.
    
    Parameters:
    
    minTitleZoomFactor - The new minimum zoom factor.
    
    Since:
    
    JViews 6.0
  - getMaxTitleZoomFactor
```
public double getMaxTitleZoomFactor()
```
    Returns the maximum zoom factor for the title.
    
    Returns:
    
    The maximum zoom factor for the title.
    
    Since:
    
    JViews 6.0
  - setMaxTitleZoomFactor
```
public void setMaxTitleZoomFactor(double maxTitleZoomFactor)
```
    Sets the maximum title zoom factor for the title.
    
    Parameters:
    
    maxTitleZoomFactor - The new zoom factor for the title.
    
    Since:
    
    JViews 6.0
  - getShadowThickness
```
public double getShadowThickness()
```
    Returns the thickness of the shadow used to draw the frame.
    
    Since:
    
    JViews 8.5
    
    See Also:
    
    setShadowThickness(double)
  - setShadowThickness
```
public void setShadowThickness(double thickness)
```
    Changes the thickness of the shadow used to draw the frame. If the shadow thickness is 0, no shadow is drawn.
    
    Parameters:
    
    thickness - The shadow thickness.
    
    Since:
    
    JViews 8.5
    
    See Also:
    
    getShadowThickness()
  - getShadowPosition
```
public int getShadowPosition()
```
    Returns the position of the shadow used to draw the frame. The return value is one of the following: IlvConstants.TOP_LEFT, IlvConstants.BOTTOM_LEFT, IlvConstants.TOP_RIGHT, or IlvConstants.BOTTOM_RIGHT.
    
    Since:
    
    JViews 8.5
    
    See Also:
    
    setShadowPosition(int)
  - setShadowPosition
```
public void setShadowPosition(int shadowPosition)
```
    Changes the position of the shadow used to draw the frame.
    
    Parameters:
    
    shadowPosition - The new position of the shadow. Valid values are IlvConstants.TOP_LEFT, IlvConstants.BOTTOM_LEFT, IlvConstants.TOP_RIGHT, or IlvConstants.BOTTOM_RIGHT.
    
    Since:
    
    JViews 8.5
    
    See Also:
    
    getShadowPosition()
  - getShadowPaint
```
public Paint getShadowPaint()
```
    Returns the paint of the shadow used to draw the frame.
    
    Since:
    
    JViews 8.5
    
    See Also:
    
    setShadowPaint(java.awt.Paint)
  - setShadowPaint
```
public void setShadowPaint(Paint paint)
```
    Changes the paint of the shadow used to draw the frame.
    
    Parameters:
    
    paint - The shadow paint.
    
    Since:
    
    JViews 8.5
    
    See Also:
    
    getShadowPaint()

Class IlvDefaultManagerFrame

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LEFT

CENTER

RIGHT

TOP

BOTTOM

WRAPPED

Constructor Detail

IlvDefaultManagerFrame

IlvDefaultManagerFrame

IlvDefaultManagerFrame

Method Detail

copy

write

setExpandCollapseIcon

getExpandCollapseIcon

isShowingExpandCollapseIcon

setShowingExpandCollapseIcon

setExpandCollapseIconPosition

getRelativeExpandCollapseIconPosition

setRelativeExpandCollapseIconPosition

getAbsoluteExpandCollapseIconPosition

setAbsoluteExpandCollapseIconPosition

getTopMargin

moveResize

managerChanged

checkZoomFactor

getTitleHeight

getTopMargin

setTopMargin

getBottomMargin

getBottomMargin

setBottomMargin

getRightMargin

getRightMargin

setRightMargin

getLeftMargin

getLeftMargin

setLeftMargin

isOpaque

getOpaque

setOpaque

getTitleColor

setTitleColor

getFont

setFont

getBackground

setBackground

getForeground

setForeground

isShowingTitle

setShowingTitle

setTitleJustification

getTitleJustification

setBaseTextDirection

setBaseTextDirection

getBaseTextDirection

getResolvedBaseTextDirection

getResolvedBaseTextDirection

baseTextDirectionChanged

componentOrientationChanged

localeChanged

draw

drawTitleText

drawTitleBackground

drawBackground

drawOutline

drawShadow

drawExpandCollapseIcon

boundingBoxExpandCollapseIcon

getExpandCollapseIconPosition

contains

getTitle

setTitle

getTitle