A divider bar that handles resize events and toggling automatically.
Inherits :
DAZ Script | |
---|---|
BarStyle | { BSFull, BSSemi, BSThin } |
DividerOrientation | { DOHorizontal, DOVertical } |
ResizeType | { RTStretchFirst, RTStretchSecond, RTStretchBoth } |
WidgetType | { WTLeftOrTop, WTRightOrBottom, WTBoth, WTNone } |
DAZ Script |
---|
DzDynamicDividerWgt ( DzWidget parent ) |
DzDynamicDividerWgt ( DzWidget parent, DzWidget firstChild, DzWidget secondChild ) |
DAZ Script | |
---|---|
void | moveDivider ( Number distance ) |
void | setDividerBar ( DividerOrientation orientation, BarStyle barStyle ) |
void | setFirstWidget ( DzWidget first ) |
void | setPreferredWidgetExtent ( WidgetType widget, Number extent ) |
void | setSecondWidget ( DzWidget second ) |
void | setToggleState ( Boolean minimized ) |
void | swapFirstAndSecondWidgets () |
void | toggleWidget () |
A Dynamic Divider takes two DzWidget objects and places a divider bar between them. It handles resize events, as well as toggling of the divider bar if toggling is enabled.
For complex arrangements you can nest instances of this class by specifying them as one of the widgets via setFirstWidget( DzWidget ) or setSecondWidget( DzWidget )
TODO: Add description.
—–
TODO: Add description.
—–
TODO: Add description.
—–
TODO: Add description.
Holds the actual position of the divider bar as a percentage in decimal format (0.5 = 50%).
DividerOrientation : dividerOrientation
Holds the orientation of the divider bar.
Holds the type of divider bar used.
Holds the margin surrounding this object.
Holds whether or not the divider bar is currently minimized.
Holds whether or not the divider bar can be moved by dragging.
Number : preferredDividerPercent
Holds the preferred position of the divider bar as a percentage in decimal format (0.5 = 50%).
Holds the preferred widget type.
Number : preferredWidgetExtent
Holds the preferred extent of the widget. This value is only used if the value of DzDynamicDividerWgt::preferredWidget is not DzDividerBar::WTNone.
Holds the spacing between the widgets and the divider bar.
Holds the direction the toggle bar will be minimized when clicked.
Holds whether or not the divider bar can be minimized when clicked.
DzDynamicDividerWgt( DzWidget parent )
Instantiates DzDynamicDividerWgt.
Parameter(s):
undefined
).Attention:
undefined
state until both setFirstWidget( DzWidget ) and setSecondWidget( DzWidget ) are called.DzDynamicDividerWgt( DzWidget parent, DzWidget firstChild, DzWidget secondChild )
Instantiates DzDynamicDividerWgt.
Parameter(s):
undefined
).undefined
).undefined
).void : moveDivider( Number distance )
Moves the divider distance pixels from the current location. If the new location will cause the divider to be displayed in an invalid location (based on minimum size requirements of the widgets), it will be moved and displayed as close as possible to the desired location.
Parameter(s):
void : setDividerBar( DividerOrientation orientation, BarStyle barStyle )
Sets the divider bar to be used for this object
Parameter(s):
void : setFirstWidget( DzWidget first )
Sets the left (or top) widget, depending on the orientation.
Parameter(s):
undefined
)void : setPreferredWidgetExtent( WidgetType widget, Number extent )
Sets the preferred extent (width or height depending on orientation) for the specified widget. If this extent cannot be used (usually due to minimum size constraints) then the divider will be positioned as close as possible to the preferred extent.
Parameter(s):
Since:
void : setSecondWidget( DzWidget second )
Sets the right (or bottom) widget, depending on the orientation.
Parameter(s):
undefined
)void : setToggleState( Boolean minimized )
Toggles the widget to the specified minimized state, if needed.
Parameter(s):
Since:
void : swapFirstAndSecondWidgets()
Swaps the left (or top) and right (or bottom) widget.
Since:
void : toggleWidget()
Toggles the widget in the direction specified by toggleDirection. If toggling is disabled, this method has no effect. If either the first or second widget is undefined
, this method will also have no effect.