Class TWizardNavigationButtonStyle

Description

TWizardNavigationButtonStyle class.

TWizardNavigationButtonStyle defines the style applied to a wizard navigation button. The button type can be specified via ButtonType, which can be 'Button', 'Image' or 'Link'. If the button is an image button, ImageUrl will be used to load the image for the button. Otherwise, ButtonText will be displayed as the button caption.

Located in /Web/UI/WebControls/TWizard.php (line 1426)

TComponent
   |
   --TStyle
      |
      --TWizardNavigationButtonStyle
Method Summary
void apply (mixed $button)
void copyFrom (TStyle $style)
string getButtonText ()
string getButtonType ()
string getImageUrl ()
void mergeWith (TStyle $style)
void reset ()
void setButtonText (string $value)
void setButtonType (string $value)
void setImageUrl (string $value)
Methods
apply (line 1537)

Applies this style to the specified button

  • access: public
void apply (mixed $button)
  • mixed $button: button to be applied with this style
copyFrom (line 1451)

Copies the fields in a new style to this style.

If a style field is set in the new style, the corresponding field in this style will be overwritten.

  • access: public
void copyFrom (TStyle $style)
  • TStyle $style: the new style

Redefinition of:
TStyle::copyFrom()
Copies the fields in a new style to this style.
getButtonText (line 1504)
  • return: button caption
  • access: public
string getButtonText ()
getButtonType (line 1520)
  • return: button type. Default to 'Button'.
  • access: public
string getButtonType ()
getImageUrl (line 1488)
  • return: image URL for the image button
  • access: public
string getImageUrl ()
mergeWith (line 1471)

Merges the style with a new one.

If a style field is not set in this style, it will be overwritten by the new one.

  • access: public
void mergeWith (TStyle $style)
  • TStyle $style: the new style

Redefinition of:
TStyle::mergeWith()
Merges the style with a new one.
reset (line 1437)

Sets the style attributes to default values.

This method overrides the parent implementation by resetting additional TWizardNavigationButtonStyle specific attributes.

  • access: public
void reset ()

Redefinition of:
TStyle::reset()
Resets the style to the original empty state.
setButtonText (line 1512)
  • access: public
void setButtonText (string $value)
  • string $value: button caption
setButtonType (line 1528)
  • access: public
void setButtonType (string $value)
  • string $value: button type. Valid values include 'Button', 'Image', 'Link'.
setImageUrl (line 1496)
  • access: public
void setImageUrl (string $value)
  • string $value: image URL for the image button

Inherited Methods

Inherited From TStyle

TStyle::__construct()
TStyle::addAttributesToRender()
TStyle::clearStyleField()
TStyle::copyFrom()
TStyle::getBackColor()
TStyle::getBorderColor()
TStyle::getBorderStyle()
TStyle::getBorderWidth()
TStyle::getCssClass()
TStyle::getCustomStyle()
TStyle::getFont()
TStyle::getForeColor()
TStyle::getHeight()
TStyle::getStyleField()
TStyle::getWidth()
TStyle::hasStyleField()
TStyle::mergeWith()
TStyle::reset()
TStyle::setBackColor()
TStyle::setBorderColor()
TStyle::setBorderStyle()
TStyle::setBorderWidth()
TStyle::setCssClass()
TStyle::setCustomStyle()
TStyle::setForeColor()
TStyle::setHeight()
TStyle::setStyleField()
TStyle::setWidth()

Inherited From TComponent

TComponent::attachEventHandler()
TComponent::canGetProperty()
TComponent::canSetProperty()
TComponent::detachEventHandler()
TComponent::evaluateExpression()
TComponent::evaluateStatements()
TComponent::getEventHandlers()
TComponent::getSubProperty()
TComponent::hasEvent()
TComponent::hasEventHandler()
TComponent::hasProperty()
TComponent::raiseEvent()
TComponent::setSubProperty()
TComponent::__get()
TComponent::__set()

Documentation generated on Sun, 04 Jun 2006 19:00:45 -0400 by phpDocumentor 1.3.0RC4