User Tools

Site Tools


DzInfoDivider

Provides a divider bar with an information panel as the second widget.

More...

Inherits :

Methods

Detailed Description

DzInfoDivider places a divider bar between your widget and a tab bar of info tabs. This class is very similar (but not exactly like) DzDynamicDividerWgt. For situations where you want to control both sides of the divider bar it is recommended to use DzDynamicDividerWgt.

Methods


Number : getActualDividerPercent()

Return Value:

  • The current divider position, or -1 if minimized.

DzInfoTabs : getInfoTabs()

Return Value:

  • The info tabs for this divider bar. The info divider allows you to display tips, metadata, and other info relating to your product.

Number : getPreferredDividerPercent()

Return Value:

  • The preffered relative position of the divider.

Number : getToggleState()

Return Value:

  • The minimized (toggled) state as a Number. * 0 = NotMinimized
  • 1 = HalfMinimized
  • 2 = FullMinimized

Boolean : isMinimized()

Return Value:

  • true if the divider bar is in a minimized state, othewise false.

This method is the same as DzInfoDivider::isToggled()


Boolean : isToggled()

Return Value:

  • true if the divider bar is in a minimized state, otherwise false.

This method is the same as DzInfoDivider::isMinimized()


void : moveDivider( Number distance )

Moves the divider distance pixels from the current location.

Parameter(s):

  • distance - The distance in pixels from the current location. If the new location will cause the divider to be displayed in an invalid location, it will be displayed in the closest location to where it was dragged

void : setPreferredDividerPercent( Number distance )

Sets the location of the divider bar.

Parameter(s):

  • position - The preffered relative position of the divider. If the new location will cause the divider to be displayed in an invalid location, it will be displayed in the closest location possible.

void : setToggleState( Number state )

Sets the toggled state of this divider bar.

Parameter(s):

  • state - The new state of this divider bar: * 0 = Not Minimized
    • 1 = Half Minimized
    • 2 = Full Minimized

void : toggleClosed()

Toggles the second widget between fully closed and fully open.


Boolean : toggleEnabled()

Return Value:

  • true if this divider bar can be toggled, otherwise false.

void : toggleMinimized()

Toggles the minimized state of the second widget. If toggling is disabled, this method has no effect. If either the first or second widget is null, toggling this method will also have no effect.